Open Onderwijs API

Versie: Open Onderwijs API 4.0
Status: Definitief - januari 2021
Sector: HO
Beheer: Werkgroep OOAPI

Beschrijving

De afspraak Open Onderwijs API (OOAPI) beschrijft het data-formaat (REST-API en JSON), semantiek en syntax waaraan onderwijsinstellingen moeten voldoen om informatie beschikbaar te kunnen stellen aan externe partijen. Dit betreft: persoonsgegevens, faculteitsgegevens, onderwijsafdelingen, onderwijsplannen, cursusgroepen, cursussen, cursusresultaten, toetsresultaten, gebouwen, ruimtes, roostergegevens, nieuwskanalen, nieuwsitems, enzovoort.
De afspraak is mede bedoeld om app-bouwers in het hoger onderwijs te helpen om deze data te ontsluiten op een gepersonaliseerde manier (voor de student) via een app.

Samenhang

Met het opzetten van de OOAPI is rekening gehouden met elementen uit de HORA. Er is geen sprake van een onderlinge verwijzing.

Zowel de HOVI als de OOAPI hebben gegevens over instellingen. Het toepassingsgebied van HOVI gaat verder in op marketingdoeleinden, de OOAPI richt zich meer op informatievoorziening richting zittende studenten en medewerkers.

Meerwaarde

Steeds meer hoger onderwijs instellingen werken aan een flexibele en persoonlijke leeromgeving: die is modulair van opzet en is opgebouwd uit verschillende applicaties van binnen en buiten de instelling. De integratie-infrastructuur zorgt voor uitwisseling van data en functionaliteit tussen deze losse applicaties. API’s zijn de interfaces tussen verschillende softwareapplicaties en zijn daardoor een onmisbaar onderdeel van een  integratie-infrastructuur. Zo kunnen onderwijsinstellingen bijvoorbeeld via apps handige informatie beschikbaar stellen: van cijfers tot studiepunten, van roosters tot vrije werkplekken. Meer informatie staat op openonderwijsapi.nl.

Gebruik

Om inzichtelijk te maken welke onderwijsinstellingen de OOAPI toepassen en welke endpoints daarbij worden ondersteund, is aan onderwijsinstellingen gevraagd om het online formulier ‘Gebruik van de Open Onderwijs API‘ in te vullen. Daarbij wordt onder andere gevraagd welke databronnen worden ontsloten met behulp van de OOAPI. Een overzicht van de responses staat op openonderwijsapi.nl/implementaties.

Ontwikkelingen

De OOAPI is aangeboden door SURF namens de projectgroep OOAPI om in beheer te worden genomen bij Edustandaard. De bestaande HO-werkgroep OOAPI zorgt voor doorontwikkeling van de standaard. Ook borgt deze werkgroep de afspraken met Edustandaard voor het beheer en de publicatie van updates en wijzigingen. Edustandaard begeleidt het proces voor vermelding van updates en wijzigingen op Edustandaard.nl en borging in de ROSA.

Op openonderwijsapi.nl staat een overzicht van de werkgroepoverleggen.