Gå til hovedinnhold

API-referanse

Utdanningsregisterets GraphQL API tilbyr queries for å hente data og mutations for å rapportere data.

Utforsk API-et i Apollo Studio

For fullstendig og oppdatert oversikt over alle felter, parametere og typer:

Se også Bruke queries og Bruke mutations for praktiske eksempler.


Queries

API-et tilbyr queries innen følgende kategorier:

  • Organisasjoner - Hent universiteter, høyskoler og andre organisasjoner
  • Utdanningsspesifikasjoner - Beskrivelser av utdanninger (studieprogram, emner, etterutdanning)
  • Utdanningsmuligheter - Hvor og hvordan utdanninger tilbys
  • Utdanningsinstanser - Konkrete gjennomføringer med tid og sted
  • Campus - Fysiske og digitale studiesteder
  • Akkreditering - Akkrediteringsinformasjon for organisasjoner og utdanninger
  • Referansedata - Kodeverk, land, språk, lover og andre referansedata

Se Apollo Studio Query-referanse for fullstendig oversikt over alle tilgjengelige queries.


Mutations

Krever skrivetilgang

Alle mutations krever sikt:utdanningsregisteret/utdanning.write scope.

API-et tilbyr mutations innen følgende kategorier:

  • Organisasjon - Endre organisasjoner og organisasjonsnavn
  • Campus og Lærested - Opprett og endre campuser og læresteder
  • Utdanningsspesifikasjon - Opprett og endre utdanningsbeskrivelser og hierarki
  • Utdanningsmulighet - Opprett og endre utdanningstilbud
  • Utdanningsinstans - Opprett og endre konkrete gjennomføringer
  • Akkreditering - Registrer akkrediteringer for organisasjoner og utdanninger
  • Referansedata - Opprett og endre språk og utdanningslover

Se Apollo Studio Mutation-referanse for fullstendig oversikt over alle tilgjengelige mutations