GET

/organisations

Request all registered Organisation objects based on the specified School. This endpoint can be used to gather all relevant organisations within the Administratiesysteem onderwijsdeelnemer for the specified school of board.

Endpoint bewerken Terug naar API

Veldspecificaties

46 items
Path Naam Type Verplicht Beperkingen
request.query.boardId
boardId

The boardIdentifier (secondary identifier) of a board. This parameter is used in combination with the boardIdType when the organisationMasterIdentifier of the Board is not available.

 Tekenreeks Nee - Bewerken
request.query.boardIdType
boardIdType

The type of the boardIdentifier. This parameter is used in combination with the boardId when the organisationMasterIdentifier of the Board is not available.

 Keuzelijst Nee toegestaan ["BGE_CODE"] Bewerken
request.query.boardMasterId
boardMasterId

The organisationMasterIdentifier of the Board. This parameter is used when the primary identifier for a board (being the OnderwijsbestuurId) is available.

 Tekenreeks Nee - Bewerken
request.query.name
name

The name of the school.

 Tekenreeks 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 Organisation object with its identifiers, name, board and locations information.

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

The Boards this School belongs to.

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

A reference to a School Board organisation.

 Object Nee - Bewerken
response.200[*].boards[*].name
name

The name of the School Board.

 Tekenreeks Nee - Bewerken
response.200[*].boards[*].organisationIds
organisationIds

A secondary identifier for the School Board. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

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

A secondary identifier for the School Board. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

 Object Nee - Bewerken
response.200[*].boards[*].organisationIds[*].organisationId
organisationId
 Tekenreeks Nee - Bewerken
response.200[*].boards[*].organisationIds[*].organisationIdType
organisationIdType
 Keuzelijst Nee toegestaan ["BGE_CODE"] Bewerken
response.200[*].boards[*].organisationMasterIdentifier
organisationMasterIdentifier

The primary identifier for a School Board. For boards the OnderwijsbestuurId is used. (either organisationMasterIdentifier or organisationIds is required)

 Tekenreeks 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 first created. Format: According to openapi in ZULU time as specified in RFC 3339, section 5.6.

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

A list of all school locations of this organisation.

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

A reference to a School location.

 Object Nee - Bewerken
response.200[*].locations[*].locationIds
locationIds

A secondary identifier for the School location. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

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

A secondary identifier for the School location. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

 Object Nee - Bewerken
response.200[*].locations[*].locationIds[*].locationId
locationId
 Tekenreeks Nee - Bewerken
response.200[*].locations[*].locationIds[*].locationIdType
locationIdType
 Keuzelijst Nee toegestaan ["VE_CODE"] Bewerken
response.200[*].locations[*].locationMasterIdentifier
locationMasterIdentifier

The primary identifier for the School location. For School locations the Onderwijslocatiecode is used. (either organisationMasterIdentifier or organisationIds is required)

 Tekenreeks Nee - Bewerken
response.200[*].locations[*].name
name

The name of the School location.

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

The name of the School.

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

A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

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

A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

 Object Nee - Bewerken
response.200[*].organisationIds[*].organisationId
organisationId
 Tekenreeks Nee - Bewerken
response.200[*].organisationIds[*].organisationIdType
organisationIdType
 Keuzelijst Nee toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"] Bewerken
response.200[*].organisationMasterIdentifier
organisationMasterIdentifier

The primary identifier for a School. For Schools the OnderwijsaanbiederId is used. (either organisationMasterIdentifier or organisationIds is required)

 Tekenreeks Nee - 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.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