GET

/studyofferings/school

Request StudyOffering objects for a specified School.

Endpoint bewerken Terug naar API

Veldspecificaties

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

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

  • true: Only StudyOfferings belonging to the specified secondary identifier are returned.
  • false: All StudyOfferings 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
request.query.schoolPeriodId
schoolPeriodId

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

 Tekenreeks Nee - Bewerken
request.query.studyCode
studyCode

Optional filter to request all StudyOffering objects of a specified studyCode.

 Tekenreeks Nee - Bewerken
response.200
response 200

OK

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

The StudyOffering object with its identifiers, name, and metadata information.

 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[*].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[*].studyCharacteristics
studyCharacteristics

Official characteristic of the study.

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

Official characteristic of the study.

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

Accepteert 4 cijfers (0011) of 4 cijfers, een 'O', en weer 4 cijfers (1000O0020). Primair onderwijs (BO & SO): opleidingseenheid code (9 karakters) conform waardelijst RIO po https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/ Voortgezet onderwijs (VO & VSO): erkende opleidingscode (4 karakters) conform Regeling Codetabellen VO, VSO en MBO https://wetten.overheid.nl/BWBR0048579/2025-08-28/?g=2025-08-28&z=2025-08-28#BijlageIa

 Tekenreeks Nee patroon ^(\d{4}|\d{4}O\d{4})$ Bewerken
response.200[*].studyLevel
studyLevel

Official level of the study. Primary and secondary education studyLevels are based on the Niveau as specified in SLO curriculum

 Object Nee - Bewerken
response.200[*].studyLevel.studyLevelId
studyLevelId

The uuid of the level.

 Tekenreeks Nee patroon ^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$ Bewerken
response.200[*].studyLevel.studyLevelName
studyLevelName

The name of the level.

 Tekenreeks Nee - Bewerken
response.200[*].studyLevel.studyLevelPrefix
studyLevelPrefix

The prefix of the level

 Tekenreeks Nee min. 4, max. 4, patroon ^[0-9]*$ Bewerken
response.200[*].studyName
studyName

Official name of the study.

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

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

 UUID Ja - Bewerken
response.200[*].studyOfferingName
studyOfferingName

The name given by the School for this StudyOffering.

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

The study year of this object.

Example values are:

  • Basisschool: 0, 1, 2, 3, 4, 5, 6, 7 or 8
  • VMBO: 0, 1, 2, 3 or 4
  • HAVO: 0, 1, 2, 3, 4 or 5
  • VWO: 0, 1, 2, 3, 4, 5 or 6
 Geheel getal Nee - 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