MinUddannelse Api

<back to all web services

GetAarsplanRequest

Requires Authentication
Required role:ForlagRequires any of the roles:NovaLink, Forlag, Trivsel, Aula, Skemaprovider, Skemasubscriber, Stamdataprovider, Elevflytning, MueApi
The following routes are available for this service:
GET/aarsplan/{id}Henter specifik årsplan med id
GET/aarsplan/ekstern_id/{eksternid}Henter specifik årsplan ud fra ekstern id
GetAarsplanRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathGuid?No
EksternIdpathstringNo
AarsplanResponseDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NavnformstringNo
BeskrivelseformstringNo
KlassetrinformintNo
FagformList<int>No
ForloebformList<AarsplanForloebDto>No
EksternIdformstringNo
AarsplanForloebDto Parameters:
NameParameterData TypeRequiredDescription
ForloebIdformGuid?NoId på forløbet som skal knyttes til årsplan skabelonen
EksternIdformstringNoUnikt id der svarer til ekstern entitet, men som er knyttet til et eksisterende forløb.
UgeFraformintYesI hvilken uge forløbet er planlagt til. Brug samme nummer i UgeFra og UgeTil for at lægge forløbet i en enkelt uge.
UgeTilformintYesI hvilen uge slutter forløbet

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /aarsplan/{id} HTTP/1.1 
Host: api.minuddannelse.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AarsplanResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ekstern.Api.Service.IO.Aarsplan">
  <Beskrivelse>String</Beskrivelse>
  <EksternId>String</EksternId>
  <Fag xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Fag>
  <Forloeb xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ekstern.Api.Dto">
    <d2p1:AarsplanForloebDto>
      <d2p1:EksternId>String</d2p1:EksternId>
      <d2p1:ForloebId>00000000-0000-0000-0000-000000000000</d2p1:ForloebId>
      <d2p1:UgeFra>0</d2p1:UgeFra>
      <d2p1:UgeTil>0</d2p1:UgeTil>
    </d2p1:AarsplanForloebDto>
  </Forloeb>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Klassetrin>0</Klassetrin>
  <Navn>String</Navn>
</AarsplanResponseDto>