openapi: 3.0.0
info:
  title: Centrale-Examens-VO
  description: "OAS3-definities op 26 november 2021 gemaakt n.a.v. de e-maildiscussies tussen betrokkenen op 24 en 25 november, gebaseerd op de berichtenspecificaties en modellen Centrale-Examens-VO. Ten opzichte van voorgaande versie zijn de wijzigingen (1) nTerm waardebereik van 0 tot 3 (was van 0 tot 2), (2) alle optionele eigenschappen worden nullable true (was default false), (3) niveau en leerjaar zijn verplicht bij Examenkandidaat (waren ten onrechte optioneel), (4) voorvoegsel is verwijderd uit Afnameleider en achternaam is verplicht bij Afnameleider (alleen id was verplicht) en (5) Bij POST afnamegroepen zijn examplarische voorbeelden toegevoegd waarbij het id bij een afnamegroep terecht ontbreekt."
  contact:
    url: https://github.com/edustandaard/Centrale-Examens-VO
  license:
    name: European Union Public License, version 1.2 (EUPL-1.2)
    url: https://eupl.eu/1.2/nl/
  version: 01.01.11
  x-imvertor-generator-version: 1.65.2
  x-yamlCompiler-stylesheets-version: "20210605"
servers:
- url: https://facet.nl/api/centrale_examens_vo/v00
  description: Facet API Auto Mocking
- url: https://www.las-leverancier.nl/api/centrale_examens_vo/v00
  description: LAS-leverancier Referentie-implementatie
paths:
  /afnamegroepen:
    get:
      tags:
      - Facet
      operationId: getcollectiongroepen
      parameters:
      - name: brin4
        in: query
        description: <body><p>BRIN4 identificatie van de school.</p></body><body><p>Het BRIN4 bestaat uit 2 cijfers gevolgd door 2 letters.</p></body>
        required: true
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{2}[A-Z]{2}$
          type: string
          example: 99XX
      - name: volgnummer
        in: query
        description: <body><p>Volgnummer dat wordt gebruikt om een onderverdeling binnen de BRIN4 aan te duiden. Er mag aan dit volgnummer geen betekenis worden gegeven.</p></body><body><p>Dit volgnummer (BRIN-vestigingsvolgnummer) bestaat uit 2 cijfers.</p></body>
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: "00"
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700000"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het routeringskenmerk van de adminstratie van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700534"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Afnamegroep'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
    post:
      tags:
      - Facet
      operationId: postafnamegroepen
      parameters:
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700000"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het routeringskenmerk van de adminstratie van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700534"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Afnamegroep'
            examples:
              voorbeeld-minimaal:
                value:
                  afnameleider: Afnameleider01
                  examen: examen20220001
                  examenkandidaat:
                  - geboortedatum: '2001-11-18T07:53:36.544Z'
                    gebruikersnaam: gebruikersnaam01
                    geslacht: M
                    niveau: "VO VMBO GL"
                    leerjaar: '3'
                    onderwijsdeelnemeridentiteit:
                    - typelabel: ECK-iD
                      waarde: eckid123
                    weergavekenmerken:
                      achternaam: Achternaam01
                      voornaam: Voornaam01
                      weergaveidentiteit: "Voornaam01 Achternaam01"
                  onderwijsorganisatie:
                    brin4: 99AA
                    volgnummer: '00'
                  planningsgegevens:
                    afnamemoment: '2021-11-18T07:53:36.544Z'
                    afnamesoort: Online
              voorbeeld-maximaal:
                value:
                  afnameleider: Afnameleider02
                  examen: examen20220001
                  examenkandidaat:
                  - benodigdeHulpmiddelen: 
                    - Verklanking
                    - Extratijd
                    geboortedatum: '2002-11-18T07:53:36.544Z'
                    gebruikersnaam: Gebruikersnaam02
                    geslacht: V
                    niveau: "VO VMBO BB"
                    leerjaar: '6'
                    onderwijsdeelnemeridentiteit:
                    - typelabel: ECK-iD
                      waarde: eckid234
                    - typelabel: LAS-key
                      waarde: laskey234
                    weergavekenmerken:
                      achternaam: Achternaam02
                      voornaam: Voornaam02
                      voorvoegsel: van de
                      weergaveidentiteit: "Voornaam02 van de Achternaam02"
                  - benodigdeHulpmiddelen: 
                    - Spellingscontrole
                    - Extratijd
                    geboortedatum: '2003-11-18T07:53:36.544Z'
                    gebruikersnaam: Gebruikersnaam03
                    geslacht: M
                    niveau: "VO VWO"
                    leerjaar: '1'
                    onderwijsdeelnemeridentiteit:
                    - typelabel: ECK-iD
                      waarde: eckid345
                    - typelabel: LAS-key
                      waarde: laskey345
                    weergavekenmerken:
                      achternaam: Achternaam03
                      voornaam: Voornaam03
                      voorvoegsel: van de
                      weergaveidentiteit: "Voornaam03 van de Achternaam03"
                  onderwijsorganisatie:
                    brin4: 99AA
                    volgnummer: '00'
                  planningsgegevens:
                    afnamemoment: '2021-11-18T07:53:36.544Z'
                    afnamesoort: Offline
      responses:
        "201":
          description: OK
          headers:
            Location:
              description: URI van de nieuwe resource
              style: simple
              explode: false
              schema:
                type: string
                format: uri
                example: /afnamegroepen/afnamegroep-abc123
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Afnamegroep'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /afnamegroepen/{id}:
    get:
      tags:
      - Facet
      operationId: getresourceafnamegroepenId
      parameters:
      - name: id
        in: path
        description: <body><p>De identificatie van de groep.</p></body>
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: afnamegroep-abc123
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700000"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het routeringskenmerk van de adminstratie van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700534"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Afnamegroep'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
    delete:
      tags:
      - Facet
      operationId: deleteafnamegroepenId
      parameters:
      - name: id
        in: path
        description: <body><p>De identificatie van de groep.</p></body>
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: afnamegroep-abc123
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700000"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het routeringskenmerk van de adminstratie van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700534"
      responses:
        "200":
          description: Verwijderactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
        "204":
          description: No content
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
    patch:
      tags:
      - Facet
      operationId: patchafnamegroepenId
      parameters:
      - name: id
        in: path
        description: <body><p>De identificatie van de groep.</p></body>
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: afnamegroep-abc123
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700000"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het routeringskenmerk van de adminstratie van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700534"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Afnamegroep'
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Afnamegroep'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /afnameleiders:
    get:
      tags:
      - Facet
      operationId: getcollectionafnameleiders
      parameters:
      - name: brin4
        in: query
        description: <body><p>BRIN4 identificatie van de school.</p></body><body><p>Het BRIN4 bestaat uit 2 cijfers gevolgd door 2 letters.</p></body>
        required: true
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{2}[A-Z]{2}$
          type: string
          example: 99XX
      - name: volgnummer
        in: query
        description: <body><p>Volgnummer dat wordt gebruikt om een onderverdeling binnen de BRIN4 aan te duiden. Er mag aan dit volgnummer geen betekenis worden gegeven.</p></body><body><p>Dit volgnummer (BRIN-vestigingsvolgnummer) bestaat uit 2 cijfers.</p></body>
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: "00"
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700000"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het routeringskenmerk van de adminstratie van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700534"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Afnameleider'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /afnameleiders/{id}:
    get:
      tags:
      - Facet
      operationId: getresourceafnameleidersId
      parameters:
      - name: id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: afnameleider-abc123
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700000"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het routeringskenmerk van de adminstratie van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700534"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Afnameleider'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /examens:
    get:
      tags:
      - Facet
      operationId: getcollectionexamens
      parameters:
      - name: examenregime
        in: query
        description: <body><p>Het examenregime is de regelgeving die van toepassing is tijdens het bepalen van de uitslag en wordt weergeven met een jaartal.</p></body><body><p>Jaartal</p></body>
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: "2022"
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van CvTE. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000112300001"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het OIN van de betreffende LAS-leverancier.  De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000114500002"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Examen'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /examens/{id}:
    get:
      tags:
      - Facet
      operationId: getresourceexamensId
      parameters:
      - name: id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: examen-abc123
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van CvTE. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000112300001"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het OIN van de betreffende LAS-leverancier.  De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000114500002"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Examen'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /examens/{id}/examenvarianten:
    get:
      tags:
      - Facet
      operationId: getcollectionexamensIdexamenvarianten
      parameters:
      - name: id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: examen-abc123
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van CvTE. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000112300001"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het OIN van de betreffende LAS-leverancier.  De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000114500002"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Examenvariant'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /resultatenscores:
    get:
      tags:
      - Facet
      operationId: getcollectionexamensIdresultatenscores
      parameters:
      - name: examenid
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: examen-abc123
      - name: brin4
        in: query
        description: <body><p>BRIN4 identificatie van de school.</p></body><body><p>Het BRIN4 bestaat uit 2 cijfers gevolgd door 2 letters.</p></body>
        required: true
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{2}[A-Z]{2}$
          type: string
          example: 99XX
      - name: volgnummer
        in: query
        description: <body><p>Volgnummer dat wordt gebruikt om een onderverdeling binnen de BRIN4 aan te duiden. Er mag aan dit volgnummer geen betekenis worden gegeven.</p></body><body><p>Het volgnummer bestaat uit 2 cijfers.</p></body>
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: "00"
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000116700000"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het routeringskenmerk van de adminstratie van de school. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000116700534"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Resultatenscores'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /examenvarianten:
    get:
      tags:
      - Facet
      operationId: getcollectionexamenvarianten
      parameters:
      - name: examenregime
        in: query
        description: <body><p>Het examenregime is de regelgeving die van toepassing is tijdens het bepalen van de uitslag en wordt weergeven met een jaartal.</p></body><body><p>Jaartal</p></body>
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: "2022"
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van CvTE. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000112300001"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het OIN van de betreffende LAS-leverancier.  De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000114500002"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Examenvariant'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /examenvarianten/{id}:
    get:
      tags:
      - Facet
      operationId: getresourceexamenvariantenId
      parameters:
      - name: id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          example: examenvariant-abc123
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie Facet het verzoekbericht ontvangt. Dit is in dit geval het OIN van CvTE. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000112300001"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het verzoekbericht verzendt. Dit is in dit geval het OIN van de betreffende LAS-leverancier.  De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
          example: "00000007000114500002"
      responses:
        "200":
          description: Zoekactie geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Rate-Limit-Limit:
              $ref: '#/components/headers/X_Rate_Limit_Limit'
            X-Rate-Limit-Remaining:
              $ref: '#/components/headers/X_Rate_Limit_Remaining'
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X_Rate_Limit_Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Examenvariant'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
  /resultatenscoresnotificaties:
    post:
      tags:
      - LAS
      description: <body><p>Notificatie over scores en resultaten. Let op, wordt alleen verstuurd als de score wijzigt (dus niet op moment van publicatie van N-termen alle cijfers berekend en toegevoegd worden).</p></body>
      operationId: postresultatenscoresnotificaties
      parameters:
      - name: brin4
        in: query
        description: <body><p>BRIN4 identificatie van de school.</p></body><body><p>Het BRIN4 bestaat uit 2 cijfers gevolgd door 2 letters.</p></body>
        required: true
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{2}[A-Z]{2}$
          type: string
          example: 99XX
      - name: volgnummer
        in: query
        description: <body><p>Volgnummer dat wordt gebruikt om een onderverdeling binnen de BRIN4 aan te duiden. Er mag aan dit volgnummer geen betekenis worden gegeven.</p></body><body><p>Het volgnummer bestaat uit 2 cijfers.</p></body>
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: "00"
      - name: edu-to
        in: query
        description: Dit geeft aan namens welke organisatie de LAS-leverancier het bericht ontvangt. Dit is in dit geval het routeringskenmerk van de administratie van de betreffende school. Dit routeringskenmerk wordt in de deelnemerslijst meegeleverd. De waarde is 20 karakters lang. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000118900534"
      - name: edu-from
        in: query
        description: Dit geeft aan namens welke organisatie Facet het bericht verstuurt. Dit is in dit geval het OIN van de school. De waarde is het 20 karakters lange routeringskenmerk. Deze parameter is verplicht volgens de Edukoppeling REST/SaaS-profiel.
        required: true
        style: form
        explode: false
        schema:
          pattern: ^(\d|\D){20}$
          type: string
        example: "00000007000116700000"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Resultatenscoresnotificatie'
      responses:
        "201":
          description: OK
          headers:
            Location:
              description: URI van de nieuwe resource
              style: simple
              explode: false
              schema:
                type: string
                format: uri
                example: /resultatenscoresnotificaties/
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resultatenscoresnotificatie'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.edustandaard.nl/amigo/api/validaties/integer
                  name: score
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill it.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "409":
          description: Conflict
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
                title: Conflict
                status: 409
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: conflict
        "410":
          description: Gone
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11
                title: Gone
                status: 410
                detail: The request could not be completed due to a conflict with the current state of the resource
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: gone
        "415":
          description: Unsupported Media Type
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
                title: Unsupported Media Type
                status: 415
                detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: unsupported
        "429":
          description: Too Many Requests
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
                title: Too many request
                status: 429
                detail: The user has sent too many requests in a given amount of time (rate limiting).
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: tooManyRequests
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented it from fulfilling the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "501":
          description: Not Implemented
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
                title: Not Implemented
                status: 501
                detail: The server does not support the functionality required to fulfill the request.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notImplemented
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldschool.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
components:
  schemas:
    Afnamegroep:
      required:
      - afnameleider
      - examen
      - examenkandidaat
      - onderwijsorganisatie
      - planningsgegevens
      type: object
      properties:
        afnameleider:
          title: afnameleider
          minLength: 1
          type: string
          description: <body><p>Verwijzing naar de examenvariant van de afnamegroep.</p></body>
          example: afnameleider-abc123
        examen:
          title: examen
          minLength: 1
          type: string
          description: <body><p>Verwijzing naar het examen van de afnamegroep.</p></body>
          example: examen-abc123
        examenkandidaat:
          type: array
          items:
            $ref: '#/components/schemas/Examenkandidaat'
        id:
          title: id
          minLength: 1
          type: string
          description: <body><p>Betekenisloze identifier van de afnamegroep. Minimaal uniek binnen de scope van een gegevensuitwisseling.</p></body><body><p>Afhankelijk van de context waarbinnen wordt uitgewisseld zijn nadere afspraken over (globale) uniciteit en persistentie mogelijk.</p></body>
          example: afnamegroep-abc123
        onderwijsorganisatie:
          $ref: '#/components/schemas/Onderwijsorganisatie'
        planningsgegevens:
          $ref: '#/components/schemas/Planningsgegevens'
      description: <body><p>Verzameling van gegevens bij een afnamegroep.</p></body>
    Afnameleider:
      required:
      - achternaam
      - id
      type: object
      properties:
        achternaam:
          title: achternaam
          type: string
          description: <body><p>Achternaam van de medewerker, inclusief voorvoegsel.</p></body>
          example: Achternaam01
        id:
          title: id
          minLength: 1
          type: string
          description: <body><p>Betekenisloze identifier. Minimaal uniek binnen de scope van een gegevensuitwisseling.</p></body><body><p>Afhankelijk van de context waarbinnen wordt uitgewisseld zijn nadere afspraken over (globale) uniciteit en persistentie mogelijk.</p></body>
          example: afnameleider-abc123
        roepnaam:
          title: roepnaam
          type: string
          description: <body><p>Roepnaam van de medewerker.</p></body>
          example: Roepnaam01
          nullable : true
      description: <body><p>Verzameling van gegevens bij een afnameleider.</p></body>
    Examen:
      allOf:
      - $ref: '#/components/schemas/Toetseenheid'
      - required:
        - afnamecondities
        - naam
        - niveau
        - typelabel
        - versie
        - vakken
        type: object
        properties:
          afnamecondities:
            $ref: '#/components/schemas/Examenafnamecondities'
          naam:
            title: naam
            minLength: 1
            type: string
            description: <body><p>Naam van het examen.</p></body>
          niveau:
            type: string
            title: niveau
            description: "<body><p>Typering van het niveau van het examen. Er zijn\
              \ afspraken gemaakt over de verschillende waarden die gebruikt zullen\
              \ worden en dit is vastgelegd in de enumeratie NiveauVO. Deze enumeratie\
              \ is niet bindend, d.w.z. kan in overleg worden aangepast.</p></body><body><p>De\
              \ verzameling van waarden die gegevens van dit attribuutsoort kunnen\
              \ hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke\
              \ structuur.</p></body>"
            minLength: 1
          omschrijving:
            title: omschrijving
            type: string
            description: <body><p>Omschrijving van het examen.</p></body>
            nullable : true
          typelabel:
            $ref: '#/components/schemas/Examentype'
          url:
            title: url
            type: string
            description: <body><p>Url naar verdere informatie over het examen.</p></body>
            format: uri
            nullable : true
          vakken:
            type: array
            description: <body><p>Geeft aan waar in een opleiding (bij welke vakken) het examen geplaatst kan worden door vermelding van de betreffende vakcodes.</p></body><body><p>Vakcode bestaat uit 4 cijfers karakters obv DUO Vakcodetabel.</p></body>
            minItems: 1
            items:
              type: string
              pattern: ^[0-9]{4}$
              minLength: 1
              example: "1001"
          versie:
            title: versie
            minLength: 1
            type: string
            description: <body><p>Versie van het examen.</p></body>
        description: <body><p>Verzameling van gegevens bij een examen. Let op, de eigenschap niveau geeft het niveau van het examen aan.</p></body>
    Examenvariant:
      allOf:
      - $ref: '#/components/schemas/Toetseenheid'
      - required:
        - examencijferberekening
        - isvariantvan
        - naam
        - typelabel
        - versie
        type: object
        properties:
          examencijferberekening:
            $ref: '#/components/schemas/Examencijferberekening'
          isvariantvan:
            title: isvariantvan
            minLength: 1
            type: string
            description: <body><p>Verwijzing naar het examen van de examenvariant.</p></body>
            example: examen-abc123
          naam:
            title: naam
            minLength: 1
            type: string
            description: <body><p>Naam van de examenvariant.</p></body>
          omschrijving:
            title: omschrijving
            type: string
            description: <body><p>Omschrijving van de examenvariant.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
            nullable : true
          typelabel:
            $ref: '#/components/schemas/Examenvarianttype'
          necode:
            title: necode
            pattern: ^[0-9]{5}$
            type: string
            description: <body><p>NE-code is een extra code die optioneel kan worden toegevoegd aan een examenvariant. Deze code is relevant om koppeling te kunnen houden met het WOI-bestand Wolf.</p></body><body><p>NE-code (aka nex_id), bestaat uit 5 karakters</p></body>
            nullable : true
          url:
            title: url
            type: string
            description: <body><p>Url naar verdere informatie over de examenvariant.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
            format: uri
            nullable : true
          versie:
            title: versie
            minLength: 1
            type: string
            description: <body><p>Versie van de examenvariant.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
        description: <body><p>Materiaal dat gebruikt wordt bij het bepalen van de voortgang in ontwikkeling van de kennis en competenties van een onderwijsvolger.</p></body>
    Resultatenscores:
      required:
      - examen
      - examenvariant
      - id
      - onderwijsdeelnemeridentiteit
      - score
      type: object
      properties:
        examen:
          title: examen
          minLength: 1
          type: string
          description: <body><p>Verwijzing naar het examen van de resultatenscores.</p></body>
          example: examen-abc123
        examenvariant:
          title: examenvariant
          minLength: 1
          type: string
          description: <body><p>Verwijzing naar de examenvariant van de resultatenscores.</p></body>
          example: examenvariant-abc123
        afnamecontext:
          $ref: '#/components/schemas/Afnamecontext'
        datumtijd:
          title: datumtijd
          type: string
          description: <body><p>Datum en tijdstip waarop de verzameling resultaten en scores is samengesteld.</p></body><body><p>Een uniek datumtijdstip uitgedrukt jaartal, maand, dag, uren, minuten en seconden volgens ISO 8601, bijvoorbeeld 2021-03-22T10:29Z.</p></body>
          format: date-time
          example: 2021-03-10T13:00:00Z
          nullable : true
        id:
          title: id
          minLength: 1
          type: string
          description: <body><p>Betekenisloze identifier van de verzameling scores en resultaten. Minimaal uniek binnen de scope van een gegevensuitwisseling.</p></body><body><p>Afhankelijk van de context waarbinnen wordt uitgewisseld zijn nadere afspraken over (globale) uniciteit en persistentie mogelijk.</p></body>
          example: resultatenscores-abc123
        onderwijsdeelnemeridentiteit:
          $ref: '#/components/schemas/Onderwijsdeelnemeridentiteit'
        resultaat:
          $ref: '#/components/schemas/Resultaat'
        score:
          $ref: '#/components/schemas/Score'
      description: <body><p>Verzameltype voor scores en resultaten uit afnames voor een enkele afname van toetsen, oefeningen en examens.</p></body>
    Resultatenscoresnotificatie:
      required:
      - examen
      type: object
      properties:
        examen:
          title: examen
          minLength: 1
          type: string
          description: <body><p>Verwijzing naar het examen van de resultatenscores-notificatie.</p></body>
          example: examen-abc123
    Afname:
      required:
      - id
      type: object
      properties:
        afnametijdstip:
          title: afnametijdstip
          type: string
          description: <body><p>Datum en tijdstip waarop de afname plaatsvond.</p></body><body><p>Een uniek datumtijdstip uitgedrukt jaartal, maand, dag, uren, minuten en seconden volgens ISO 8601, bijvoorbeeld 2021-03-22T10:29Z.</p></body>
          format: date-time
          example: 2021-03-22T10:29:00Z
          nullable : true
        id:
          title: id
          minLength: 1
          type: string
          description: <body><p>Betekenisloze identifier. Minimaal uniek binnen de scope van een gegevensuitwisseling.</p></body><body><p>Afhankelijk van de context waarbinnen wordt uitgewisseld zijn nadere afspraken over (globale) uniciteit en persistentie mogelijk.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          example: afname-abc123
        protocol:
          title: protocol
          type: string
          description: <body><p>URL naar het afnameprotocol.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          format: uri
          nullable : true
        protocoltext:
          title: protocoltext
          type: string
          description: <body><p>Tekstuele weergave van het afnameprotocol.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          nullable : true
        resultaatverwerker:
          title: resultaatverwerker
          type: string
          description: <body><p>Aanduiding van de partij die de resultaten verwerkt.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          nullable : true
      description: <body><p>Gegevens over de wijze waarop het resultaat tot stand is gekomen. Elke afname heeft een eigen id.</p></body>
    Afnamecontext:
      type: object
      properties:
        afname:
          $ref: '#/components/schemas/Afname'
        bron:
          $ref: '#/components/schemas/Bron'
      description: <body><p>Informatie over de plek, tijd en wijze waarop de toets is afgenomen.</p></body>
    Bron:
      required:
      - url
      type: object
      properties:
        url:
          title: url
          type: string
          description: <body><p>URL naar de (detail)resultaten, waarmee de verwerker van de resultaten inzicht kan verlenen in de gedetailleerde scores.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          format: uri
      description: <body><p>URL die verwijst naar (detail)informatie in het systeem van de toetsleverancier.</p></body><body><p>Kan bijvoorbeeld verwijzen naar de resultaten of scores van individuele personen, of toegang geven tot resultaten of scores van items, indien beschikbaar bij de uitgever.</p></body>
    Examenafnamecondities:
      required:
      - afnameperiodeBegin
      - afnameperiodeEind
      - duurAfname
      - examenregime
      - inplanbaar
      type: object
      properties:
        afnameperiodeBegin:
          type: string
          title: afnameperiodeBegin
          description: "<body><p>De begintijd (inclusief datum) van de tijdsperiode waarbinnen de afname kan worden gepland.</p></body><body><p>Een tijdsperiode uitgedrukt in tijdstip volgens ISO 8601, bijvoorbeeld 2021-03-24T09:00:00Z.</p></body>"
          format: date-time
          example: "2021-03-24T09:00:00Z"
        afnameperiodeEind:
          type: string
          title: afnameperiodeEind
          description: "<body><p>De begintijd (inclusief datum) van de tijdsperiode waarbinnen de afname kan worden gepland.</p></body><body><p>Een tijdsperiode uitgedrukt in tijdstip volgens ISO 8601, bijvoorbeeld 2021-03-24T17:00:00Z.</p></body>"
          format: date-time
          example: "2021-03-24T17:00:00Z"
        begintijdAfname:
          title: begintijdAfname
          type: string
          description: <body><p>Het moment van begin van de afname.</p></body><body><p>Een uniek datumtijdstip uitgedrukt jaartal, maand, dag, uren, minuten en seconden volgens ISO 8601, bijvoorbeeld 2021-03-22T10:29Z.</p></body>
          format: date-time
          example: 2021-03-22T10:29:00Z
          nullable : true
        duurAfname:
          title: duurAfname
          type: integer
          description: <body><p>De tijdsduur van de afname in minuten.</p></body>
        examenregime:
          title: examenregime
          pattern: ^[0-9]{4}$
          type: string
          description: <body><p>Het examenregime is de regelgeving die van toepassing is tijdens het bepalen van de uitslag en wordt weergeven met een jaartal.</p></body><body><p>Jaartal</p></body>
          example: "2022"
        individueleHulpmiddelen:
          type: array
          title: individueleHulpmiddelen
          description: "<body><p>De lijst van hulpmiddelen die individueel toegestaan\
            \ zijn voor het examen.</p><p>Er zijn  afspraken gemaakt over de verschillende waarden die gebruikt zullen worden en dit is vastgelegd in de enumeratie HulpmiddelenSoort. Deze enumeratie is niet bindend, d.w.z. kan in overleg worden aangepast.</p></body>"
          minItems: 0
          items:
            type: string
        inplanbaar:
          title: inplanbaar
          type: boolean
        standaardHulpmiddelen:
          type: array
          title: standaardHulpmiddelen
          description: "<body><p>De lijst van hulpmiddelen die standaard toegestaan\
            \ zijn voor het examen.</p><p>Er zijn  afspraken gemaakt over de verschillende waarden die gebruikt zullen worden en dit is vastgelegd in de enumeratie HulpmiddelenSoort. Deze enumeratie is niet bindend, d.w.z. kan in overleg worden aangepast.</p></body>"
          minItems: 0
          items:
            type: string
        tijdvak:
          title: tijdvak
          type: integer
          description: <body><p>Numerieke aanduiding van het tijdvak waarin het examen plaatsvindt. Indien niet gevuld is het examen niet gebonden aan een tijdvak.</p></body>
          example: 1
          nullable : true
    Examencijferberekening:
      allOf:
      - $ref: '#/components/schemas/Referentieschaal'
      - required:
        - examencijferparameters
        type: object
        properties:
          examencijferparameters:
            $ref: '#/components/schemas/Examencijferparameters'
        description: <body><p>De berekening van het examencijfer, op basis van score (S), schaallengte (L) en N-term (N).</p></body>
    Examencijferparameters:
      type: object
      properties:
        nTerm:
          title: n-term
          maximum: 3
          minimum: 0
          type: number
          description: '<body><p>De normeringsterm (N), vast te stellen door het College voor examens middels een normeringsbeslissing.</p></body><body><p>Liggend tussen de waarden: N = 0.0 en N = 2.0.</p></body>'
          example: 1
          nullable : true
        schaallengte:
          title: schaallengte
          type: integer
          description: <body><p>De lengte van de scoreschaal (L), zoals vastgelegd in het correctievoorschrift.</p></body>
          example: 68
          nullable : true
      description: <body><p>De parameters (N-term en schaallengte) die bij de berekening van het examencijfer worden betrokken.</p></body>
    Examenkandidaat:
      required:
      - geboortedatum
      - gebruikersnaam
      - geslacht
      - leerjaar
      - niveau
      - onderwijsdeelnemeridentiteit
      - weergavekenmerken
      type: object
      properties:
        benodigdeHulpmiddelen:
          type: array
          title: benodigdeHulpmiddelen
          description: "<body><p>De lijst van hulpmiddelen die de examenkandidaat nodig heeft om het examen te maken.</p><p>Er zijn  afspraken gemaakt over de verschillende waarden die gebruikt zullen worden en dit is vastgelegd in de enumeratie HulpmiddelenSoort. Deze enumeratie is niet bindend, d.w.z. kan in overleg worden aangepast.</p></body>"
          minItems: 0
          items:
            type: string
        geboortedatum:
          title: geboortedatum
          type: string
          description: "<body><p>De geboortedatum van de examenkandidaat.</p></body><body><p>Een datum uitgedrukt jaartal, maand en dag volgens ISO 8601, bijvoorbeeld 2021-03-22.</p></body>"
          format: date
          example: 2001-03-22
        gebruikersnaam:
          title: gebruikersnaam
          minLength: 1
          type: string
          description: "<body><p>De gebruikersnaam waarmee de kandidaat inlogt in Facet.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>"
          example: gebruikersnaam01
        geslacht:
          $ref: '#/components/schemas/Geslachttype'
        leerjaar:
          $ref: '#/components/schemas/Leerjaartype'
        niveau:
          type: string
          title: niveau
          description: "<body><p>Het niveau van de examenkandidaat. Gebruik hiervoor het enkelvoudige niveau van de opleiding waarvoor de kandidaat is ingeschreven. Er zijn afspraken gemaakt over de verschillende waarden die gebruikt zullen worden en dit is vastgelegd in de enumeratie NiveauVO. Deze enumeratie is niet bindend, d.w.z. kan in overleg worden aangepast.</p></body>"
          minLength: 1
        onderwijsdeelnemeridentiteit:
          type: array
          items:
            $ref: '#/components/schemas/Onderwijsdeelnemeridentiteit'
        weergavekenmerken:
          $ref: '#/components/schemas/Weergavekenmerken'
      description: <body><p>Verzameling van gegevens bij een examenkandidaat. Let op, de eigenschappen niveau en leerjaar geven het niveau en het leerjaar van de opleiding/studie van de examenkandidaat aan. Bijvoorbeeld, als een havo 4 examenkandidaat plant voor afname van een vwo 6 examen dan wordt hier VO-HAVO en Leerjaar 4 ingevuld.</p></body>
    Onderwijsdeelnemeridentiteit:
      required:
      - typelabel
      - waarde
      type: object
      properties:
        typelabel:
          $ref: '#/components/schemas/Identiteittype'
        waarde:
          title: waarde
          minLength: 1
          type: string
          description: <body><p>Identifier binnen de door het label aangegeven identificatiewijze.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          example: laskey-abc123
      description: <body><p>Verwijzing naar informatie over de persoon in de vorm van een identifier van de persoon in een bepaalde registratie.</p></body><body><p>Voorbeelden van identificatiewijzen zijn ECKiD, BSN, Onderwijsnummer, of elke andere registratie (bijvoorbeeld LAS, SIS of HR-systeem) waaraan een identiteit kan worden ontleend. Afhankelijk van de toepassing is het gebruik van bepaalde vormen van identificatie al dan niet toegestaan.</p></body>
    Onderwijsorganisatie:
      required:
      - brin4
      - volgnummer
      type: object
      properties:
        brin4:
          title: brin4
          pattern: ^[0-9]{2}[A-Z]{2}$
          type: string
          description: <body><p>BRIN4 identificatie van de school.</p></body><body><p>Het BRIN4 bestaat uit 2 cijfers gevolgd door 2 letters.</p></body>
          example: 99AA
        volgnummer:
          title: volgnummer
          pattern: ^[0-9]{2}$
          type: string
          description: <body><p>Volgnummer dat wordt gebruikt om een onderverdeling binnen de BRIN4 aan te duiden. Er mag aan dit volgnummer geen betekenis worden gegeven.</p></body><body><p>Het volgnummer bestaat uit 2 cijfers.</p></body>
          example: "00"
      description: <body><p>Verwijzing naar informatie over de onderwijsorganisatie in de vorm van een identifier van de organisatie in een bepaalde registratie.</p></body>
    Planningsgegevens:
      required:
      - afnamemoment
      - afnamesoort
      type: object
      properties:
        afnamemoment:
          title: afnamemoment
          type: string
          format: date-time
        afnamesoort:
          $ref: '#/components/schemas/Afnamesoort'
      description: <body><p>Verzameling van planningsgegevens bij een afnamegroep.</p></body>
    Resultaat:
      required:
      - typelabel
      - waarde
      type: object
      properties:
        mutatiedatum:
          title: mutatiedatum
          type: string
          description: <body><p>Moment waarop het resultaat voor het laatst gewijzigd is.</p></body><body><p>Een uniek datumtijdstip uitgedrukt jaartal, maand, dag, uren, minuten en seconden volgens ISO 8601, bijvoorbeeld 2021-03-22T10:29Z.</p></body>
          format: date-time
          example: 2021-03-22T10:29:00Z
          nullable : true
        typelabel:
          $ref: '#/components/schemas/CEVOResultaattype'
        waarde:
          title: waarde
          minLength: 1
          type: string
          description: <body><p>De behaalde resultaatwaarde.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
      description: <body><p>Resultaat bepaald na normering van de ruwe scores.</p></body>
    Score:
      required:
      - id
      - typelabel
      - waarde
      type: object
      properties:
        id:
          title: id
          minLength: 1
          type: string
          description: <body><p>Betekenisloze identifier. Minimaal uniek binnen de scope van een gegevensuitwisseling.</p></body><body><p>Afhankelijk van de context waarbinnen wordt uitgewisseld zijn nadere afspraken over (globale) uniciteit en persistentie mogelijk.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          example: scores-abc123
        mutatiedatum:
          title: mutatiedatum
          type: string
          description: <body><p>Moment waarop de score voor het laatst gewijzigd is.</p></body><body><p>Een uniek datumtijdstip uitgedrukt jaartal, maand, dag, uren, minuten en seconden volgens ISO 8601, bijvoorbeeld 2021-03-22T10:29Z.</p></body>
          format: date-time
          example: 2021-03-22T10:29:00Z
          nullable : true
        typelabel:
          $ref: '#/components/schemas/CEVOScoretype'
        waarde:
          title: waarde
          minLength: 1
          type: string
          description: <body><p>De behaalde scorewaarde.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
      description: <body><p>Een individuele score.</p></body>
    Weergavekenmerken:
      required:
      - achternaam
      - voornaam
      - weergaveidentiteit
      type: object
      properties:
        achternaam:
          title: achternaam
          minLength: 1
          type: string
          description: <body><p>De achternaam van de examenkandidaat die op het scherm wordt weergegeven, t.b.v. controle door de examenleider.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          example: Achternaam01
        voornaam:
          title: voornaam
          minLength: 1
          type: string
          description: <body><p>De voornaam van de examenkandidaat die op het scherm wordt weergegeven, t.b.v. controle door de examenleider.</p></body>
          example: Voornaam01
        voorvoegsel:
          title: voorvoegsel
          type: string
          description: <body><p>Voorvoegsel bij de achternaam van de examenkandidaat die op het scherm wordt weergegeven, t.b.v. controle door de examenleider.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          example: van de
          nullable : true
        weergaveidentiteit:
          title: weergaveidentiteit
          minLength: 1
          type: string
          description: <body><p>Identiteit van de examenkandidaat (bijv. leerlingnummer) die op het scherm wordt weergegeven, t.b.v. controle door de examenleider.</p></body>
          example: leerling01
      description: <body><p>Kenmerken die (alleen) op het scherm weergegeven worden.</p></body>
    Referentieschaal:
      type: object
      properties:
        referentietoelichting:
          title: referentietoelichting
          type: string
          description: <body><p>Tekst met nadere uitleg over de herkomst van de referentieschaal en wijze van presentatie of gebruik.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          example: Zie de Regeling omzetting scores in cijfers centrale examens en rekentoets VO 2016
          nullable : true
        verwijzingReferentietoelichting:
          title: verwijzingReferentietoelichting
          type: string
          description: <body><p>Url naar tekst met nadere uitleg over de herkomst van de referentieschaal en wijze van presentatie of gebruik.</p></body><body><p>De verzameling van waarden die gegevens van dit attribuutsoort kunnen hebben, dat wil zeggen het waardenbereik, uitgedrukt in een specifieke structuur.</p></body>
          format: uri
          example: https://wetten.overheid.nl/BWBR0037590/2020-01-01
          nullable : true
      description: <body><p>Instrument om scores te plaatsen op een schaal.</p></body>
    Toetseenheid:
      required:
      - id
      type: object
      properties:
        id:
          title: id
          minLength: 1
          type: string
          description: <body><p>Betekenisloze identifier. Minimaal uniek binnen de scope van een gegevensuitwisseling.</p></body><body><p>Afhankelijk van de context waarbinnen wordt uitgewisseld zijn nadere afspraken over (globale) uniciteit en persistentie mogelijk.</p></body>
    Afnamesoort:
      type: string
      enum:
      - Online
      - Offline
    CEVOResultaattype:
      type: string
      enum:
      - Eindcijfer eindexamen VO
    CEVOScoretype:
      type: string
      enum:
      - VO Examenscore
    Examentype:
      type: string
      enum:
      - CBT
      - CPE
      - CSE
      - CSPE
      - CHE
      - PRETEST
      - POSTTEST
      - VOORBEELDEXAMEN
      - AANGEWEZEN
    Examenvarianttype:
      type: string
      enum:
      - Examenvariant
    Geslachttype:
      type: string
      description: <body><ul><li>`M` - Man</li><li>`V` - Vrouw</li><li>`O` - Ontbrekend / Niet gespecificeerd</li></ul></body>
      enum:
      - M
      - V
      - O
    Identiteittype:
      type: string
      enum:
      - ECK-iD
      - LAS-key
    Leerjaartype:
      type: string
      enum:
      - "1"
      - "2"
      - "3"
      - "4"
      - "5"
      - "6"
    BadRequestFoutbericht:
      allOf:
      - $ref: '#/components/schemas/Foutbericht'
      - type: object
        properties:
          invalidParams:
            type: array
            description: Foutmelding per fout in een parameter. Alle gevonden fouten worden één keer teruggemeld.
            items:
              $ref: '#/components/schemas/InvalidParams'
    Foutbericht:
      type: object
      properties:
        type:
          type: string
          description: Link naar meer informatie over deze fout
          format: uri
          nullable : true
        title:
          type: string
          description: Beschrijving van de fout
          nullable : true
        status:
          type: integer
          description: Http status code
          nullable : true
        detail:
          type: string
          description: Details over de fout
          nullable : true
        instance:
          type: string
          description: Uri van de aanroep die de fout heeft veroorzaakt
          format: uri
          nullable : true
        code:
          minLength: 1
          type: string
          description: Systeemcode die het type fout aangeeft
          nullable : true
      description: Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807).
    InvalidParams:
      type: object
      properties:
        type:
          type: string
          format: uri
          example: https://www.edustandaard.nl/amigo/api/{major-versie}/validaties/integer
          nullable : true
        name:
          type: string
          description: Naam van de parameter
          example: verblijfplaats__huisnummer
          nullable : true
        code:
          minLength: 1
          type: string
          description: Systeemcode die het type fout aangeeft
          example: integer
          nullable : true
        reason:
          type: string
          description: Beschrijving van de fout op de parameterwaarde
          example: Waarde is geen geldige integer.
          nullable : true
      description: Details over fouten in opgegeven parameters
  headers:
    api_version:
      schema:
        type: string
        description: Geeft een specifieke API-versie aan in de context van een specifieke aanroep.
        example: 1.0.0
        nullable : true
    warning:
      schema:
        type: string
        description: zie RFC 7234. In het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 ("Miscellaneous Persistent Warning") en het API end-point (inclusief versienummer) als de warn-agent van de warning, gevolgd door de warn-text met de human-readable waarschuwing
        example: '299 https://service.../api/.../v1 "Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1".'
        nullable : true
    X_Rate_Limit_Limit:
      schema:
        type: integer
    X_Rate_Limit_Remaining:
      schema:
        type: integer
    X_Rate_Limit_Reset:
      schema:
        type: integer