GET

/schoolperiods/school

Request SchoolPeriod objects for a specified School.

Endpoint bewerken Terug naar API

Veldspecificaties

29 items
Path Naam Type Verplicht Beperkingen
request.query.filterByOrgId
filterByOrgId

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

  • true: Only SchoolPeriods belonging to the specified secondary identifier are returned.
  • false: All SchoolPeriods 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.
 Ja/nee Nee - Bewerken
request.query.orgId
orgId

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

 Tekenreeks Nee - Bewerken
request.query.orgIdType
orgIdType

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
 Keuzelijst Nee toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"] Bewerken
request.query.orgMasterId
orgMasterId

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

 Tekenreeks Nee - Bewerken
response.200
response 200

OK

 Lijst[] Nee - Bewerken
response.200[*]
response 200

The SchoolPeriod object with its title startDate and endDate.

 Object Nee - Bewerken
response.200[*].dateCreated
dateCreated

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.

 Datum/tijd Ja - Bewerken
response.200[*].dateLastModified
dateLastModified

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.

 Datum/tijd Ja - Bewerken
response.200[*].endDate
endDate

The end date for the SchoolPeriod (exclusive). Format: YYYY-MM-DD (according to RFC3339).

 Datum Ja - Bewerken
response.200[*].schoolPeriodId
schoolPeriodId

A unique identifier for this SchoolPeriod object. For a full schoolyear this identifier has the format "beginyear-endyear", for example "2024-2025". Otherwise this identifier is a UUID. This is the UUID that Consumers will refer to when making API calls, or when needing to identify an object.

 Tekenreeks Ja - Bewerken
response.200[*].startDate
startDate

The start date for the SchoolPeriod (inclusive). Format: YYYY-MM-DD (according to RFC3339).

 Datum Ja - Bewerken
response.200[*].status
status

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.

 Keuzelijst Ja toegestaan ["active","tobedeleted"] Bewerken
response.200[*].subSchoolPeriods
subSchoolPeriods

The link to hierarchically lower Schoolperiod objects. For example for a schoolYear these are its semesters.

 Lijst[] Nee - Bewerken
response.200[*].subSchoolPeriods[*]
subSchoolPeriods

The link to a child Schoolperiod object. For example for a schoolYear this is the semester.

 Tekenreeks Nee - Bewerken
response.200[*].superSchoolPeriod
superSchoolPeriod

The link to a hierarchically higher Schoolperiod object. For example for a semester this is the schoolYear.

 Tekenreeks Nee - Bewerken
response.200[*].title
title

The name of the SchoolPeriod.

 Tekenreeks Ja - Bewerken
response.200[*].type
type

The type of SchoolPeriod. An enumerated value is used:

  • gradingPeriod: Denotes a period over which some grade/result is to be awarded.
  • schoolYear: Denotes the school year.
  • semester: Denotes a semester period. Typically there are two semesters per schoolYear.
  • term: Denotes a term period. Typically there are three terms per schoolYear.

ENUM values are corresponding the OneRoster AcademicSession SessionType.

 Keuzelijst Nee toegestaan ["gradingPeriod","schoolYear","semester","term"] Bewerken
response.400
response 400

Functional status code and status message.

 Object Nee - Bewerken
response.400.status
status

See functional status codes within the Documentation.

 Geheel getal Ja - Bewerken
response.400.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee - Bewerken
response.401
response 401

Functional status code and status message.

 Object Nee - Bewerken
response.401.status
status

See functional status codes within the Documentation.

 Geheel getal Ja - Bewerken
response.401.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee - Bewerken
response.403
response 403

Functional status code and status message.

 Object Nee - Bewerken
response.403.status
status

See functional status codes within the Documentation.

 Geheel getal Ja - Bewerken
response.403.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee - Bewerken
response.404
response 404

Functional status code and status message.

 Object Nee - Bewerken
response.404.status
status

See functional status codes within the Documentation.

 Geheel getal Ja - Bewerken
response.404.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee - Bewerken

Verwachte statuscodes

5 items
Code Betekenis Uitkomst
200 OK Succes Bewerken
400 Bad Request Fout Bewerken
401 Unauthorized Fout Bewerken
403 Forbidden Fout Bewerken
404 Not Found Fout Bewerken