/students/school

Controls whether the response is filtered to only include Students belonging to the specific organisation identified by orgId and orgIdType, or whether all Students of the associated Onderwijsaanbieder are returned.

• true: Only Students belonging to the specified secondary identifier are returned.
• false: All Students of the associated Onderwijsaanbieder are returned (to the extent authorisations have been configured).

When omitted, a sector-specific default applies:

• PO (primary education): defaults to true – response is filtered to the specified identifier.
• VO (secondary education): defaults to false – response covers the full Onderwijsaanbieder scope.

This parameter is only relevant in combination with orgId and orgIdType. When orgMasterId is used, this parameter must be absent or false.

It is the responsibility of the consuming party to verify whether the Source supports filtering via this parameter before using it.

The organisationIdentifier (secondary identifier) of the school. This parameter is used in combination with the orgIdType when the organisationMasterIdentifier is not available.

The type of the organisationIdentifier. This parameter is used in combination with the orgId when the organisationMasterIdentifier is not available.

The following values are supported:

• OIE_CODE: OnderwijsInstellingserkenningcode
• BP_ID: Basispoort-generated identifier for the school
• DD_ID: DigiDeliveryId generated by the Central Registration of Edu-iX
• AS_ID: LAS-generated identifier (LAS-Key) for the school
• V_ID: VestigingsId – BRIN6-format identifier, including dummy locations

The organisationMasterIdentifier of the school. This parameter is used when the primary identifier for a school (being the OnderwijsaanbiederId) is available.

Optional filter to request all Student objects enrolled in a specified SchoolPeriod and its corresponding schoolPeriodId.

Optional filter to request all Student objects enrolled in a StudyOffering and its corresponding studyOfferingId.

Optional filter to request Student objects enrolled in a SubjectOffering and its corresponding subjectOfferingId.

OK

The Student object with its identifiers and name information.

Based on the scopes additional attributes can be included in this object.

student.demographics

Demographic data of a Student:

• dateOfBirth
• gender

student.communication

Communication data of the Student. For Students this is only the e-mail address as provided by the School.

student.accessibility

accessibility and language preferences for the Student. StudentAccessibility is an optional object for the Students API.

• As an illustration the accessibility of AdditionalTestingTime is specified within this version.
• Based on actual requirements from schools and suppliers, this list of preferences can be extended.
• A possible next candidate might be the Braille class.

student.deliveryaddress

Delivery address data of a Student:

• address
• emailPrivate
• emailsParents

Accessibility preferences for this student. Based on IMS Global Access for All (AfA) Personal Needs and Preferences (PNP) Information model

The AdditionalTestingTime preference for a Student. Either time-multiplier, fixed-minutes or unlimited is used.

Providing the additional testing time as an additional number of minutes.

Providing the additional testing time as a multiplier of the set time.

Providing the additional testing time as an unlimited time.

The home address of the Student.

According to Alpha-2 code from ISO 3166, e.g. NL

the house number

additions to the house number, e.g. A or -104

An additional field to distinct students on screen who carry the same name.

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.

format: YYYY-MM-DD (according to RFC3339)

E-mail address hosted by school (e.g. L123456@school.nl).

Private e-mail address of the student.

E-mail address of a parent or the legal representative (e.g. guardian) of the Student.

The gender of the Student. The following values are used:

• female: gender is Female
• male: gender is Male
• other: gender that is known but which is not either Male or Female.
• unspecified: unspecified as no data entry for this field has been made.

The language preference of the Student. Format according to ISO639 Set 3 values for Language tags. On Wikipedia an example list can be found.

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.

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

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

The primary identifier for the Student. For Students the ECK iD is used.

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.