/employees/school

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

• true: Only Employees belonging to the specified secondary identifier are returned.
• false: All Employees 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 Employee objects within a specified SchoolPeriod and its corresponding schoolPeriodId.

OK

The Employee object with its identifiers and name information.

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

employee.communication

Communication data of the Employee. For Employees this is the e-mail address, phone number or mobile phone number as provided by the School.

employee.roles

organisationRoles of the Employee within the school.

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

Indicates the date and time the object was first created. Format: Conform openapi in ZULU time zoals gespecificeerd in RFC 3339, section 5.6.

Indicates the date and time the object was last modified. Format: Conform openapi in ZULU time zoals gespecificeerd in RFC 3339, section 5.6.

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

Mobile phone number as provided by the school.

The organisation roles the Employee has within the organisation.

The organisation roles the Employee has within the organisation.

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

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

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)

The organisation role the Employee has within the organisation.

Phone number as provided by the school.

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

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.