/enrollments/school/student

A reference to a School organisation.

A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

The primary identifier for a School. For Schools the OnderwijsaanbiederId is used. (either organisationMasterIdentifier or organisationIds is required)

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

The primary identifier for a User. For Students the ECK iD is used. For Employees this value is empty. There is no primary identifier for Employees. (either userMasterIdentifier or userIds is required)

Optional filter to request all Enrollment objects for a specified enrollmentType.

Optional filter to request all Enrollment objects within a specified SchoolPeriod and its corresponding schoolPeriodId.

Optional filter to request all Enrollment objects into a StudyOffering and its corresponding studyOfferingId.

Optional filter to request all Enrollment objects into a SubjectOffering and its corresponding subjectOfferingId.

OK

The Enrollment object for a student into a StudyYear or SubjectOffering for a SchoolPeriod.

The start date on which the enrollment becomes active (inclusive). Format: YYYY-MM-DD (according to RFC3339).

Indicates the date and time the object was first created. Format: According to openapi in ZULU time as specified in RFC 3339, section 5.6.

Indicates the date and time the object was last modified. Format: According to openapi in ZULU time as specified in RFC 3339, section 5.6.

The end date on which the enrollment becomes inactive (exclusive). Format: YYYY-MM-DD (according to RFC3339).

A unique identifier for this Enrollment object. This is the GUID that Consumers will refer to when making API calls, or when needing to identify an object.

The type of enrollment, being one of:

• study: an enrollment into a StudyOffering offered by the School.
• subject: an enrollment into a SubjectOffering offered by the School.

A reference to a Location of a School.

A secondary identifier for the Location. For Locations the Vestigingserkenning aka VE_CODE is used. This value is used whenever the primary identifier is not available. (either locationMasterIdentifier or locationIds is required)

A secondary identifier for the Location. For Locations the Vestigingserkenning aka VE_CODE is used. This value is used whenever the primary identifier is not available. (either locationMasterIdentifier or locationIds is required)

The primary identifier for a Location. For Locations the Onderwijslocatie aka OL_CODE is used. (either locationMasterIdentifier or locationIds is required)

A name for the Location.

A reference to the schoolPeriodId of the SchoolPeriod where this enrollment is part of.

The status field gives an indication to Consumers about the status of an object. Consumers can delete objects that are flagged tobedeleted as such if they wish.

The status attribute is based on the Base Class from OneRoster.

The Student to which this enrollment object belongs.

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

The primary identifier for a User. For Students the ECK iD is used. For Employees this value is empty. There is no primary identifier for Employees. (either userMasterIdentifier or userIds is required)

A reference to the studyOfferingId of the StudyOffering in case this enrollment is of the enrollmentType study.

A reference to the public id of the StudyOffering in RIO in case this enrollment is of the enrollmentType study

The study year of this object in case the enrollment is of the enrollmentType 'study'

Example values are:

• Basisschool: 0, 1, 2, 3, 4, 5, 6, 7 or 8
• VMBO: 1, 2, 3 or 4
• HAVO: 1, 2, 3, 4 or 5
• VWO: 1, 2, 3, 4, 5 or 6

A reference to the subjectOfferingId of the SubjectOffering in case this enrollment is of the enrollmentType subject.

Functional status code and status message.

See functional status codes within the Documentation.

See functional status messages within the Documentation.

Functional status code and status message.

See functional status codes within the Documentation.

See functional status messages within the Documentation.

Functional status code and status message.

See functional status codes within the Documentation.

See functional status messages within the Documentation.

Functional status code and status message.

See functional status codes within the Documentation.

See functional status messages within the Documentation.