Required role: | Forlag | Requires any of the roles: | NovaLink, Forlag, Trivsel, Aula, Skemaprovider, Skemasubscriber, Stamdataprovider, Elevflytning, MueApi |
GET | /forloeb/ | Henter alle forløb |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | query | int | No | |
Take | query | int | No | |
Medejere | query | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalCount | form | int | No | |
Forloeb | form | IEnumerable<ForloebResponseDto> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
Fag | form | IEnumerable<int> | No | |
Titel | form | string | No | |
Farve | form | string | No | |
Url | form | string | No | |
Billede | form | string | No | |
Forfattere | form | IEnumerable<string> | No | |
BeskrivelseTilElev | form | string | No | |
BeskrivelseTilLaerer | form | string | No | |
Faellesmaal | form | IEnumerable<int> | No | |
Kapitler | form | IEnumerable<KapitelDto> | No | |
Klassetrin | form | int | No | |
EksternId | form | string | No | |
SkjulFraBibliotek | form | bool | No | |
Medejere | form | IEnumerable<string> | No | |
Oprettet | form | DateTime? | No | |
KlassetrinFra | form | int? | No | |
KlassetrinTil | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Overskrift | form | string | No | Overskriften på kapitlet. Hvis dette ikke udfyldes navngives kapitlerne ud for deres rækkefølge eks. Kapitel 1, Kapitel 2 osv. |
Laeringsmaal | form | IEnumerable<LaeringsmaalDto> | No | Liste af læringsmål der skal arbejdes med i kapitlet |
Sider | form | IEnumerable<SideDto> | Yes | Liste af sider i kapitlet |
Id | form | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Tekst | form | string | Yes | Tekst der beskriver et læringsmål |
TegnPaaLaering | form | IEnumerable<string> | No | Liste af tegn på læring i forbindelse med et læringsmål |
Id | form | Guid | No | |
Faellesmaal | form | IEnumerable<int> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Overskrift | form | string | No | Overskrift på siden. Hvis dette ikke udfyldes navngives siderne ud fra deres rækkefølge eks. Side 1, Side 2 osv. |
Elementer | form | IEnumerable<ElementDto> | Yes | Liste med indholds elementer på siden. Dette kan f.eks. være tekster, billeder, lærer kommentar osv. |
Id | form | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ElementType | form | ElementType? | Yes | Typen af indholds element.Allowable Values
|
ErOpgave | form | bool | No | Om elementet skal præsenteres som en opgave. Kan kun indeholde simpel html som beskrivelse af opgaven. |
Indhold | form | string | Yes |
Indholdet af elementet som kan være enten tekst, html eller escaped json string. Tilladte værdier per element type:
|
Id | form | Guid | No |
Laererkommentar |
Text |
Link |
Picture |
Materiale |
Youtube |
File |
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.
GET /forloeb/ HTTP/1.1 Host: api.minuddannelse.net Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { totalCount: 0 }