Veldspecificaties

28 items
Veld Beschrijving Type Verplicht Beperkingen
request.query.id
id
Tekenreeks Ja -
request.query.orgMasterId
orgMasterId
Tekenreeks Nee -
request.query.orgId
orgId
Tekenreeks Nee -
request.query.orgIdType
orgIdType
Keuzelijst Nee -
response.200
response 200

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

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

Tekenreeks Ja -
response.200.studyOfferingName
studyOfferingName

The name given by the School for this StudyOffering.

Tekenreeks Ja -
response.200.studyName
studyName

Official name of the study. - primary education: the po-opleidingseenheden in RIO korte naam name as specified in Waardenlijst Opleidingseenheden po is used. - secondary education: the vo-opleidingseenheden in RIO korte naam name as specified in Waardenlijst Opleidingseenheden vo is used.

Tekenreeks Nee -
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 -
response.200.studyCharacteristics
studyCharacteristics

Official characteristic of the study. - primary education: the po-opleidingskenmerken name as specified in Waardenlijst Opleidingseenheden po is used. - secondary education: the vo-opleidingskenmerken name as specified in Waardenlijst Opleidingseenheden vo is used.

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

Official characteristic of the study. - primary education: the po-opleidingskenmerken name as specified in Waardenlijst Opleidingseenheden po is used. - secondary education: the vo-opleidingskenmerken name as specified in Waardenlijst Opleidingseenheden vo is used.

Object Nee -
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 -
response.200.studyLevelId
studyLevelId

The uuid of the level.

Tekenreeks Ja -
response.200.studyLevelPrefix
studyLevelPrefix

The prefix of the level

Tekenreeks Ja -
response.200.studyLevelName
studyLevelName

The name of the level.

Tekenreeks Ja -
response.200.studyLevelName
studyLevelName

The name of the level.

Tekenreeks Ja -
response.400
response 400

Functional status code and status message.

Object Nee -
response.400.status
status

See functional status codes within the Documentation.

Geheel getal Ja -
response.400.statusMessage
statusMessage

See functional status messages within the Documentation.

Tekenreeks Nee -
response.401
response 401

Functional status code and status message.

Object Nee -
response.401.status
status

See functional status codes within the Documentation.

Geheel getal Ja -
response.401.statusMessage
statusMessage

See functional status messages within the Documentation.

Tekenreeks Nee -
response.403
response 403

Functional status code and status message.

Object Nee -
response.403.status
status

See functional status codes within the Documentation.

Geheel getal Ja -
response.403.statusMessage
statusMessage

See functional status messages within the Documentation.

Tekenreeks Nee -
response.404
response 404

Functional status code and status message.

Object Nee -
response.404.status
status

See functional status codes within the Documentation.

Geheel getal Ja -
response.404.statusMessage
statusMessage

See functional status messages within the Documentation.

Tekenreeks Nee -

Verwachte statuscodes

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

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /studyofferings/school/{id}:
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: 'Reference to the studyOfferingId of the StudyOffering object.'
      - schema:
          type: string
        name: orgMasterId
        in: query
        required: false
        description: |
          The organisationMasterIdentifier of the school.
          This parameter is used when the primary identifier for a school (being the `OnderwijsaanbiederId`) is available.
      - schema:
          type: string
        name: orgId
        in: query
        required: false
        description: |
          The organisationIdentifier (secondary identifier) of the school.
          This parameter is used in combination with the orgIdType when the organisationMasterIdentifier is not available.
      - schema:
          type: string
          example: DD_ID
          enum:
            - OIE_CODE
            - BP_ID
            - DD_ID
            - AS_ID
            - V_ID
        name: orgIdType
        in: query
        required: false
        description: |
          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
    get:
      summary: 'Get StudyOffering'
      x-tags:
        - StudyOffering
      tags:
        - Administratiesysteem onderwijsdeelnemer
      operationId: get-studyofferings
      description: 'Request StudyOffering object based on its studyOfferingId.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudyOffering'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
      security:
        - OAuth2:
            - eduv.education