MinUddannelse Api

<back to all web services

ForloebRequest

Opret og opdater forløb

Requires Authentication
Required role:ForlagRequires any of the roles:Forlag, Trivsel, Aula, Skemaprovider, Skemasubscriber, Stamdataprovider, Elevflytning, MueApi
The following routes are available for this service:
POST/forloeb/Opretter et nyt forløb
PUT/forloeb/{id}Opdaterer et eksisterende forløb
PUT/forloeb/ekstern_id/{eksternid}Opdaterer et eksisterende forløb ud fra ekstern id
ForloebRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathGuid?No
EksternIdpathstringNoEt unikt id til at knytte forløb til ekstern entitet
TitelbodystringYesForløbets titel
FarvebodystringYesHex kode der angiver farven på forløbet ex. #ff0000 (rød)
Klassetrinbodyint?YesKlassetrin som forløbet henvender sig til og som bruges til fremsøgning i forløbs biblioteket

Valid Range: 0 - 10

KlassetrinFrabodyint?YesKlassetrin som forløbet henvender sig til og som bruges til fremsøgning i forløbs biblioteket

Valid Range: 0 - 10

KlassetrinTilbodyint?YesKlassetrin som forløbet henvender sig til og som bruges til fremsøgning i forløbs biblioteket

Valid Range: 0 - 10

ForfatterebodyList<string>YesListe med forløbets forfattere
FagbodyList<int>YesListe af UVM id over fag som forløbet vedrører. Det første fag er det primære.
KapitlerbodyList<KapitelDto>YesListe af kapitler knyttet til forløbet
BeskrivelseTilElevbodystringYesBeskrivelse af forløbet som kun vises til elever. Må indeholde html.
BeskrivelseTilLaererbodystringNoBeskrivelse af forløbet som kun vises til lærer. Må indeholde html.
UrlbodystringNoUrl til onlineressourcer vedrørende forløbet
BilledebodystringNoUri til et billede der anvendes til visningen af forløbet
FaellesmaalbodyList<int>NoListe af Forenklede Fælles Mål der skal knyttes til forløbet. Brug de officielle UVM id'er.
SkjulFraBibliotekbodybool?No
MedejerebodyList<string>NoListe af medejere på et forløb som der kan filtreres på når forløb udlæses via GET /forloeb/ - dette kan eks. være en liste af unilogins eller bruger id'er
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.

POST /forloeb/ HTTP/1.1 
Host: api.minuddannelse.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ForloebRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ekstern.Api.Services.Mul.Forloeb.IO">
  <BeskrivelseTilElev>String</BeskrivelseTilElev>
  <BeskrivelseTilLaerer>String</BeskrivelseTilLaerer>
  <Billede>String</Billede>
  <EksternId>String</EksternId>
  <Faellesmaal xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Faellesmaal>
  <Fag xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Fag>
  <Farve>String</Farve>
  <Forfattere xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Forfattere>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Kapitler xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ekstern.Api.Dto">
    <d2p1:KapitelDto>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <d2p1:Laeringsmaal i:nil="true" />
      <d2p1:Overskrift>String</d2p1:Overskrift>
      <d2p1:Sider i:nil="true" />
    </d2p1:KapitelDto>
  </Kapitler>
  <Klassetrin>0</Klassetrin>
  <KlassetrinFra>0</KlassetrinFra>
  <KlassetrinTil>0</KlassetrinTil>
  <Medejere xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Medejere>
  <SkjulFraBibliotek>false</SkjulFraBibliotek>
  <Titel>String</Titel>
  <Url>String</Url>
</ForloebRequest>

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

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">00000000-0000-0000-0000-000000000000</guid>