/organisations - Education (P) - Edu-V Compliance Testlab

Veldspecificaties

37 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.boardMasterId`	boardMasterId	Tekenreeks	Nee	-
`request.query.boardId`	boardId	Tekenreeks	Nee	-
`request.query.boardIdType`	boardIdType	Keuzelijst	Nee	-
`request.query.name`	name	Tekenreeks	Nee	-
`response.200`	response 200 The Organisation object with its identifiers, name, board and locations information.	Object	Nee	-
`response.200.organisationMasterIdentifier`	organisationMasterIdentifier The primary identifier for a School. For Schools the `OnderwijsaanbiederId` is used. (either organisationMasterIdentifier or organisationIds is required)	Tekenreeks	Nee	-
`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	-
`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	-
`response.200.organisationIds[*].organisationId`	organisationId	Tekenreeks	Ja	-
`response.200.organisationIds[*].organisationIdType`	organisationIdType	Keuzelijst	Ja	toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"]
`response.200.name`	name The name of the School.	Tekenreeks	Ja	-
`response.200.boards`	boards The Boards this School belongs to.	Lijst[]	Nee	-
`response.200.boards[*]`	boards The Boards this School belongs to.	Object	Nee	-
`response.200.boards[*].organisationId`	organisationId	Tekenreeks	Ja	-
`response.200.boards[*].organisationIdType`	organisationIdType	Keuzelijst	Ja	toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"]
`response.200.locations`	locations A list of all school locations of this organisation.	Lijst[]	Nee	-
`response.200.locations[*]`	locations A list of all school locations of this organisation.	Object	Nee	-
`response.200.locations[*].organisationId`	organisationId	Tekenreeks	Ja	-
`response.200.locations[*].organisationIdType`	organisationIdType	Keuzelijst	Ja	toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"]
`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 first created. 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.

  /organisations:
    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: string
        name: boardMasterId
        in: query
        required: false
        description: |
          The organisationMasterIdentifier of the Board.
          This parameter is used when the primary identifier for a board (being the `OnderwijsbestuurId`) is available.
      - schema:
          type: string
        name: boardId
        in: query
        required: false
        description: |
          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.
      - schema:
          type: string
          example: DD_ID
          enum:
            - BGE_CODE
        name: boardIdType
        in: query
        required: false
        description: |
          The type of the boardIdentifier.
          This parameter is used in combination with the boardId when the organisationMasterIdentifier of the Board is not available.
      - schema:
          type: string
        name: name
        in: query
        required: false
        description: |
          The name of the school.
    get:
      summary: 'Get Organisations'
      x-tags:
        - Organisation
      tags:
        - Administratiesysteem onderwijsdeelnemer
      operationId: get-organisations-by-school-search
      description: |
        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.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Organisation'
        '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