MinUddannelse Api

<back to all web services

GetForloebListeRequest

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/forloeb/Henter alle forløb
GetForloebListeRequest Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNo
TakequeryintNo
MedejerequeryList<string>No
GetForloebListeResponse Parameters:
NameParameterData TypeRequiredDescription
TotalCountformintNo
ForloebformIEnumerable<ForloebResponseDto>No
ForloebResponseDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FagformIEnumerable<int>No
TitelformstringNo
FarveformstringNo
UrlformstringNo
BilledeformstringNo
ForfattereformIEnumerable<string>No
BeskrivelseTilElevformstringNo
BeskrivelseTilLaererformstringNo
FaellesmaalformIEnumerable<int>No
KapitlerformIEnumerable<KapitelDto>No
KlassetrinformintNo
EksternIdformstringNo
SkjulFraBibliotekformboolNo
MedejereformIEnumerable<string>No
OprettetformDateTime?No
KlassetrinFraformint?No
KlassetrinTilformint?No
KapitelDto Parameters:
NameParameterData TypeRequiredDescription
OverskriftformstringNoOverskriften på kapitlet. Hvis dette ikke udfyldes navngives kapitlerne ud for deres rækkefølge eks. Kapitel 1, Kapitel 2 osv.
LaeringsmaalformIEnumerable<LaeringsmaalDto>NoListe af læringsmål der skal arbejdes med i kapitlet
SiderformIEnumerable<SideDto>YesListe af sider i kapitlet
IdformGuidNo
LaeringsmaalDto Parameters:
NameParameterData TypeRequiredDescription
TekstformstringYesTekst der beskriver et læringsmål
TegnPaaLaeringformIEnumerable<string>NoListe af tegn på læring i forbindelse med et læringsmål
IdformGuidNo
FaellesmaalformIEnumerable<int>No
SideDto Parameters:
NameParameterData TypeRequiredDescription
OverskriftformstringNoOverskrift på siden. Hvis dette ikke udfyldes navngives siderne ud fra deres rækkefølge eks. Side 1, Side 2 osv.
ElementerformIEnumerable<ElementDto>YesListe med indholds elementer på siden. Dette kan f.eks. være tekster, billeder, lærer kommentar osv.
IdformGuidNo
ElementDto Parameters:
NameParameterData TypeRequiredDescription
ElementTypeformElementType?YesTypen af indholds element.

Allowable Values

  • Laererkommentar
  • Text
  • Link
  • Picture
  • Materiale
ErOpgaveformboolNoOm elementet skal præsenteres som en opgave. Kan kun indeholde simpel html som beskrivelse af opgaven.
IndholdformstringYes Indholdet af elementet som kan være enten tekst, html eller escaped json string.

Tilladte værdier per element type:
  • Laererkommentar: html
  • Text: html
  • Link/Materiale: escaped json string

    Format: {"source":"egetmateriale","data":{"url":"http://minuddannelse.net","emne":"MinUddannelse","beskrivelse":"MinUddannelse læringsplatformen"}}
    Eksempel element med link indhold:: 
    {
  "ElementType": "Link",
  "ErOpgave": false,
  "Indhold": "{\"source\":\"egetmateriale\",\"data\":{\"url\":\"http://minuddannelse.net\",\"emne\":\"MinUddannelse\",\"beskrivelse\":\"MinUddannelse læringsplatformen\"}}"
}


  • Picture: escaped json string

    Format: {"source":"link","link":"https://www.minuddannelse.net/Content/Graphics/Frontpage/frontpage_logo.png"}
    Eksempel element med picture indhold::
    {
  "ElementType": "Picture",
  "ErOpgave": false,
  "Indhold": "{\"source\":\"link\",\"link\":\"https://www.minuddannelse.net/Content/Graphics/Frontpage/frontpage_logo.png\"}"
}

IdformGuidNo
ElementType Enum:
Laererkommentar
Text
Link
Picture
Materiale
Youtube
File

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 /forloeb/ HTTP/1.1 
Host: api.minuddannelse.net 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetForloebListeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ekstern.Api.Service.IO.Forloeb">
  <Forloeb i:nil="true" />
  <TotalCount>0</TotalCount>
</GetForloebListeResponse>