/groups/school/{id}

Reference to the groupId of the Group object.

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.

The Group object in which Students follow their education and Employees are assigned to within a SchoolPeriod.

The Assignments of Employees that are assigned to this group.

A reference to the assignmentId of the Assignment for this group.

The start date on which the group 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 group becomes inactive (exclusive). Format: YYYY-MM-DD (according to RFC3339).

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

The name of this Group.

The type of group, being one of:

• class: a stamgroep where students are rostered into for their StudyOffering(s)
• lesson-group: a lesgroep where students are rostered into to follow a SubjectOffering.

A reference to the schoolPeriodId of the SchoolPeriod where this group 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 Students which are member of this group.

The Students which are member of this group.

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.