| Required role: | Forlag | Requires any of the roles: | NovaLink, Forlag, Trivsel, Aula, Skemaprovider, Skemasubscriber, Stamdataprovider, Elevflytning, MueApi |
| POST | /aarsplan/ | Opretter en ny årsplan skabelon | |
|---|---|---|---|
| PUT | /aarsplan/{id} | Opdaterer en eksisterende årsplan skabelon | |
| PUT | /aarsplan/ekstern_id/{eksternid} | Opretter eller opdaterer en eksisterende årsplan skabelon ud fra ekstern id |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | Guid? | No | |
| EksternId | path | string | No | Et unikt id til at knytte årsplan til ekstern entitet |
| Fag | body | IEnumerable<int> | Yes | Liste af UVM id over fag som årsplanen vedrører. |
| Navn | body | string | Yes | Navn på årsplanen |
| Klassetrin | body | int? | Yes | Klassetrin på årsplan skabelonenValid Range: 0 - 10 |
| Beskrivelse | body | string | No | Beskrivelse af årsplan skabelonen. Må indeholde html. |
| Forloeb | body | IEnumerable<AarsplanForloebDto> | Yes | Forløb som er knyttet til årsplanen i hvilke uger. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ForloebId | form | Guid? | No | Id på forløbet som skal knyttes til årsplan skabelonen |
| EksternId | form | string | No | Unikt id der svarer til ekstern entitet, men som er knyttet til et eksisterende forløb. |
| UgeFra | form | int | Yes | I hvilken uge forløbet er planlagt til. Brug samme nummer i UgeFra og UgeTil for at lægge forløbet i en enkelt uge. |
| UgeTil | form | int | Yes | I hvilen uge slutter forløbet |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /aarsplan/ HTTP/1.1
Host: api.minuddannelse.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 00000000000000000000000000000000,
eksternId: String,
navn: String,
klassetrin: 0,
beskrivelse: String
}