API-definitie bewerken - Edu-V Compliance Testlab

Name

Referentiecomponent

Transactierol

Interactie

Description

The Students API is implemented by the `Administratiesysteem onderwijsdeelnemer`.

Student data is split into the following objects with corresponding attributes:
- Basic data: identifiers and name
- Demographics: gender and dateOfBirth
- Communication: email
- Accessibility: language and accessibility preferences
- DeliveryAddress: home address and email addresses

Not all Student attributes are available to all consuming reference components. For example delivery address attributes are only available to the `Bestelomgeving leermiddelen`.
All objects have a different security scope which allows the `Administratiesysteem onderwijsdeelnemer` to share the attributes only with the reference components that are allowed to receive the attributes.

All consuming reference components require consent to request data from the Student API.
The Notifications API can be used by consuming reference components to receive notifications about new, modified, or deleted entities within the Students API.

The Students API has a scope of primary and secondary education. Vocational education is out of scope. For Vocational Education we advise to use the [Open Education API (OOAPI)](https://openonderwijsapi.nl/).

Annuleren