Swagger

Cheat sheet for Swagger-løsningen vår

Denne artikkelen er under arbeid. Foreslå gjerne endringer og forbedringer

Enkelte av GET-forspørslene i Greps Swagger-løsning er ikke like intuitive når det kommer til hvilke verdier kan legges inn i feltene {type}, {kode}, {format} osv. Derfor har vi nedenfor listet opp alle typer GET-forespørsler med et hint om hva som er forventet verdi for de enkelte.

Legg merke til forskjellen på forventet {type} i en URL-request, og "grep-type" som attributt i alle forekomster.

• NOR1211 forekommer i arrayet http://data.udir.no/kl06/v201906/fagkoder (plur.)
• NOR1211 er av "grep-type": "http://psi.udir.no/ontologi/kl06/fagkode" (sing.)

Verdi for {type} i GET-requestene nedenfor, er grep-typen i plural form, f.eks "fagkoder". En forespørsel etter f.eks. /kl06/v201906/fagkoder, returnerer et array av alle fagkoder i Grep, men den samme forespørselen etterfulgt av f.eks. /NOR1211, gjør altså et oppslag på den gitte forekomsten av grep-typen "fagkode".

Se også liste-over-alle-typene-i-Grep

TODO: Skrive mer om {filter} og {format}

Lenke til Swagger-løsningen:

• UI: https://data.udir.no/kl06/swagger/ui/index#/Rest
• Definisjoner:
  • v201906: https://data.udir.no/swagger/docs/201906
  • v201802: https://data.udir.no/swagger/docs/201802
  • v201604: https://data.udir.no/swagger/docs/201604

GET-requests:

Beskrivelse:

• Det som er skrevet i {krøllparanteser} erstattes med en forekomst av det som nevnes der, inkludert krøllparantesen i seg selv.
• {version} er versjonen du ønsker retur fra. Siste versjon er p.t. "201906"
• Det innskutte kulepunktet under hvert kulepunkt nevner vi forventet/lovlig verdi for {type}, f.eks "programomraade" eller "fagkode".
• {kode} er kode for en forekomst av typen som er lagt inn i {type}, f.eks. "NOR1211" hvis typen er "fagkode"

Liste over GET-requests:

• /kl06/v{version}/{type}/{kode}
  • type: alle typer
• /kl06/v{version}/{type}/{kode}.{format}
  • type: alle typer
• /kl06/v{version}/{type}/{kode}/laereplaner
  • type: programomraader
• /kl06/v{version}/{type}/{kode}/laereplaner.{format}
  • type: programomraader
• /kl06/v{version}/{type}/{kode}/laereplaner/{filter}
  • type: programomraader
• /kl06/v{version}/{type}/{kode}/laereplaner/{filter}.{format}
  • type: programomraader
• /kl06/v{version}/{type}/{kode}/opplaeringsfag
  • type: programomraader
• /kl06/v{version}/{type}/{kode}/opplaeringsfag.{format}
  • type: programomraader
• /kl06/v{version}/{type}/{kode}/opplaeringsfag/{filter}
  • type: programomraader
• /kl06/v{version}/{type}/{kode}/opplaeringsfag/{filter}.{format}
  • type: programomraader
• /kl06/v{version}/{type}/{kode}/programomraader
  • type: fagkoder
• /kl06/v{version}/{type}/{kode}/programomraader.{format}
  • type: fagkoder
• /kl06/v{version}/{type}/{kode}/programomraader/{filter}
  • type: fagkoder
• /kl06/v{version}/{type}/{kode}/programomraader/{filter}.{format}
  • type: fagkoder
• /kl06/v{version}/aarstrinn
• /kl06/v{version}/aarstrinn.{format}
• /kl06/v{version}/eksamensformer
• /kl06/v{version}/eksamensformer.{format}
• /kl06/v{version}/eksamensordninger
• /kl06/v{version}/eksamensordninger.{format}
• /kl06/v{version}/fagkategorier
• /kl06/v{version}/fagkategorier.{format}
• /kl06/v{version}/fagkoder
• /kl06/v{version}/fagkoder.{format}
• /kl06/v{version}/fagomraader
• /kl06/v{version}/fagomraader.{format}
• /kl06/v{version}/fagtyper
• /kl06/v{version}/fagtyper.{format}
• /kl06/v{version}/grunnleggende-ferdigheter-lk20
• /kl06/v{version}/grunnleggende-ferdigheter-lk20.{format}
• /kl06/v{version}/hovedomraader
• /kl06/v{version}/hovedomraader.{format}
• /kl06/v{version}/karakterer
• /kl06/v{version}/karakterer.{format}
• /kl06/v{version}/kjerneelementer-lk20
• /kl06/v{version}/kjerneelementer-lk20.{format}
• /kl06/v{version}/kompetansemaal
• /kl06/v{version}/kompetansemaal.{format}
• /kl06/v{version}/kompetansemaal-lk20
• /kl06/v{version}/kompetansemaal-lk20.{format}
• /kl06/v{version}/kompetansemaalsett
• /kl06/v{version}/kompetansemaalsett.{format}
• /kl06/v{version}/kompetansemaalsett-lk20
• /kl06/v{version}/kompetansemaalsett-lk20.{format}
• /kl06/v{version}/laereplan/diffkompetansemaal/{gammel}/{ny}
  • gammel: kode for gammel læreplan
  • ny: kode for ny læreplan
• /kl06/v{version}/laereplan/diffkompetansemaal/{gammel}/{ny}.{format}
  • gammel: kode for gammel læreplan
  • ny: kode for ny læreplan
• /kl06/v{version}/laereplaner
• /kl06/v{version}/laereplaner.{format}
• /kl06/v{version}/laereplaner-lk20
• /kl06/v{version}/laereplaner-lk20.{format}
• /kl06/v{version}/merkelapper
• /kl06/v{version}/merkelapper.{format}
• /kl06/v{version}/merknader
• /kl06/v{version}/merknader.{format}
• /kl06/v{version}/opplaeringsfag
• /kl06/v{version}/opplaeringsfag.{format}
• /kl06/v{version}/opplaeringsnivaa
• /kl06/v{version}/opplaeringsnivaa.{format}
• /kl06/v{version}/ordforklaringer-lk20
• /kl06/v{version}/ordforklaringer-lk20.{format}
• /kl06/v{version}/programomraader
• /kl06/v{version}/programomraader.{format}
• /kl06/v{version}/programomraader/{kode}/fagkoder
• /kl06/v{version}/programomraader/{kode}/fagkoder.{format}
• /kl06/v{version}/programomraader/{kode}/fagkoder/{filter}
• /kl06/v{version}/programomraader/{kode}/fagkoder/{filter}.{format}
• /kl06/v{version}/semester
• /kl06/v{version}/semester.{format}
• /kl06/v{version}/spraak
• /kl06/v{version}/spraak.{format}
• /kl06/v{version}/status
• /kl06/v{version}/status.{format}
• /kl06/v{version}/trekkordninger
• /kl06/v{version}/trekkordninger.{format}
• /kl06/v{version}/tverrfaglige-temaer-lk20
• /kl06/v{version}/tverrfaglige-temaer-lk20.{format}
• /kl06/v{version}/utdanningsprogram
• /kl06/v{version}/utdanningsprogram.{format}
• /kl06/v{version}/verb-lk20
• /kl06/v{version}/verb-lk20.{format}
• /kl06/v{version}/vurderingsuttrykk
• /kl06/v{version}/vurderingsuttrykk.{format}