05. API for prøver.udir.no

Alle URL'er listet i denne seksjonen er relative til en base basert på hvilket miljø som benyttes. Se miljøoversikten for disse baseadressene. Det er satt opp et dedikert miljø for SAS og det anbefales at man benytter dette miljøet fremfor andre når det er snakk om testing av API'et som tilbys mot SAS'ene. APIet er dokumentert med swagger og finnes her:

https://proverapi-sas.udir.no/swagger/ui/index#/SAS_-_Skoleadministrative_systemer

Med unntak av domenespesifikke ord (f.eks prøve, elev m.m.) vil vi som hovedregel benytte engelsk språk.

API vil kreve XML på payload som skal sendes inn, men tilbyr både JSON og XML på responser fra API'et. Standard format på payload som returneres er JSON, dersom man ønsker XML spesifiseres det med header:

Accept: application/xml

Oppdaterte XSD for testmiljøet kan alltid lastes ned fra: https://proverapi-sas.udir.no/sas/schema

API

Ressurs: ~/sas/schema

Verb: GET

All input fra SAS vil bli validert mot et sett med xsd skjemaer. Ressursen returnerer en ZIP-fil med valideringsskjemaene som benyttes til å validere payload sendt inn til API'et på de ulike ressursene.

Returnerer 200 OK
Krever ikke autentisering.

Ressurs: ~/sas/proveoversikt?skoleorgno={organisasjonsnummer til skolen}

Verb: GET

Returnerer en oversikt over hvilke prøver som er tilgjengelig for påmelding/gjennomføring med utgangspunkt i dagens dato. Datamodellen for dataene som returneres i payload på respons på tjenesten finnes [her] (https://goo.gl/CtFYgI). Standard format på payload som returneres er JSON, dersom man ønsker XML spesifiseres det med Accept: application/xml

Returnerer 200 OK
Krever ikke autentisering.

Ressurs: ~/sas/pamelding

Verb: POST

Foreta påmelding med XML payload som beskriver elevene som skal meldes på. I responsen vil det returneres en guid som igjen kan benyttes for å hente status på en gitt påmelding. Datamodellen som skal benyttes ifm påmelding er illustrert [her] (https://www.lucidchart.com/publicSegments/view/ebdf3d51-7bae-42c6-8066-c37f69d0c93b/image.png).

Returnerer 202 Accepted
Krever autentisering.

Ressurs: ~/sas/pamelding/{guid}

Verb: GET

Med referansen fra ~/sas/pamelding kan man benytte denne ressursen for å hente ut en gitt status på en påmelding. Datamodellen som returneres som rapport er illustrert [her] (https://www.lucidchart.com/publicSegments/view/423055f0-e6fa-4274-8e95-d74cfa2f3e06/image.png). Standard format på payload som returneres er JSON, dersom man ønsker XML spesifiseres det med Accept: application/xml.

Returnerer 200 Ok
Krever autentisering.

Ressurs: ~/sas/elev?skoleorgno={organisasjonsnummer til skolen}

Verb: GET

Denne ressursen vil returnere alle påmeldte elever og tilhørende prøvegruppeansvarlige for en gitt skole. Datamodellen som returneres som rapport er illustrert [her] (https://www.lucidchart.com/publicSegments/view/e7a24945-9ab6-40cf-a199-e6f572cad728/image.png). Standard format på payload som returneres er JSON, dersom man ønsker XML spesifiseres det med Accept: application/xml.

Returnerer 200 Ok
Krever autentisering.