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