Veldspecificaties

29 items
Veld Beschrijving Type Verplicht Beperkingen
request.query.orgMasterId
orgMasterId
Tekenreeks Nee -
request.query.orgId
orgId
Tekenreeks Nee -
request.query.orgIdType
orgIdType
Keuzelijst Nee -
request.query.filterByOrgId
filterByOrgId
Boolean Nee -
request.query.subjectCode
subjectCode
Tekenreeks Nee -
request.query.studyOfferingId
studyOfferingId
Tekenreeks Nee -
request.query.schoolPeriodId
schoolPeriodId
Tekenreeks Nee -
response.200
response 200

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

Object Nee -
response.200.subjectOfferingId
subjectOfferingId

A unique identifier for this SubjectOffering 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.subjectOfferingName
subjectOfferingName

The name given by the School to this SubjectOffering.

Tekenreeks Ja -
response.200.subjectOfferingAbbr
subjectOfferingAbbr

Abbreviation of the SubjectOffering name.

Tekenreeks Nee -
response.200.subjectCode
subjectCode

Official code of the subject. - primary education: the vakcode as specified in Waardenlijst Vakken po is used. - secondary education: the vakcode as specified in Waardenlijst Vakken vo is used. Note: The value list is not yet available. As Edu-V we are working on a standardized list of subject codes in cooperation with the Edustandaard working committee.

Tekenreeks Nee -
response.200.studyOfferings
studyOfferings
Lijst[] Nee -
response.200.studyOfferings[*]
studyOfferings
Object Nee -
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"]
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 -
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 -
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.

  /subjectofferings/school:
    parameters:
      - 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
      - schema:
          type: boolean
        name: filterByOrgId
        in: query
        required: false
        description: |
          Controls whether the response is filtered to only include SubjectOfferings belonging to the
          specific organisation identified by `orgId` and `orgIdType`, or whether all SubjectOfferings
          of the associated Onderwijsaanbieder are returned.
          - `true`: Only SubjectOfferings belonging to the specified secondary identifier are returned.
          - `false`: All SubjectOfferings 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.
      - schema:
          type: string
        name: subjectCode
        in: query
        required: false
        description: 'Optional filter to request all SubjectOffering objects of a specified subjectCode.'
      - schema:
          type: string
        name: studyOfferingId
        in: query
        required: false
        description: 'Optional filter to request all SubjectOffering objects offered within a Study and its corresponding studyOfferingId.'
      - schema:
          type: string
        name: schoolPeriodId
        in: query
        required: false
        description: 'Optional filter to request all SubjectOffering objects within a specified SchoolPeriod and its corresponding schoolPeriodId.'
    get:
      summary: Get SubjectOfferings for School
      x-tags:
        - SubjectOffering
      tags:
        - Administratiesysteem onderwijsdeelnemer
      operationId: get-subjectofferings-for-school
      description: 'Request SubjectOffering objects for a specified School.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SubjectOffering'
        '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