Primair en Voortgezet Onderwijs

The Results API is implemented by the receiver of assessment or test scores/results, typically the Administratiesysteem leerresultaten and Leermiddelendashboard.

The Results API is the destination of assessment or test scores and/or results and provides a POST endpoint to receive the latest state.

One main entity is available to consumers of the Results API (e.g. Digitaal toetssysteem and Gebruiksomgeving digitale leermiddelen):

• AssessmentScoresAndResults: the full set of scores/results information for an individual or a group of students.

In this object AssessmentScoresAndResults several objects are defined and used, like Assessment, ScoreScale and StudentScoresAndResults.

The Education API is implemented by the Administratiesysteem onderwijsdeelnemer.

The Education API has the following objects:

• Organisation: school organisations
• StudyOffering: the study units including the study year offered by a school
• SubjectOffering: the subjects offered by a school

These objects could be considered open data from the school. As a data owner, the school authorizes the exchange of this information towards suppliers. A possible implementation for an Administratiesysteem onderwijsdeelnemer is to offer an open data option to the school. This option means that a reference component that is allowed to consume the Education API to request data without the consent mechanism.

The Education 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).

The Employees API is implemented by the Administratiesysteem onderwijsmedewerker.

Employee data is split into the following objects with corresponding attributes:

• Basic data: identifiers and name
• Communication: email, phone, and mobile
• Roles: organisation roles of the employee within the school

Not all Employee attributes are available to all consuming reference components. All objects have a different security scope which allows the Administratiesysteem onderwijsmedewerker 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 Employees API. The Notifications API can be used by consuming reference components to receive notifications about new, modified, or deleted entities within the Employees API.

The Employees 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).