Administratiesysteem onderwijsdeelnemer

The Association API is implemented by the Administratiesysteem onderwijsdeelnemer.

The Association API has the following objects:

• SchoolPeriod: the school period in which this school is organized.
• Enrollment: an enrollment of a student into a StudyYear or subject.
• Assignment: an assignment of an employee to a Group or a student.
• Group: a class or lesson-group of students and the employees that are assigned to it.

These objects could be considered open data from the school. As a data owner, the school authorizes the exchange of this information towards suppliers. All consuming reference components require consent to request data from the Association API. The Notifications API can be used by consuming reference components to receive notifications about new, modified, or deleted entities within the Association API.

The Association 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 Association API is implemented by the Administratiesysteem onderwijsdeelnemer.

The Association API has the following objects:

• SchoolPeriod: the school period in which this school is organized.
• Enrollment: an enrollment of a student into a StudyYear or subject.
• Assignment: an assignment of an employee to a Group or a student.
• Group: a class or lesson-group of students and the employees that are assigned to it.

These objects could be considered open data from the school. As a data owner, the school authorizes the exchange of this information towards suppliers. All consuming reference components require consent to request data from the Association API. The Notifications API can be used by consuming reference components to receive notifications about new, modified, or deleted entities within the Association API.

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

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