/agreements - DPA (P) - Edu-V Compliance Testlab

Veldspecificaties

20 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.supplierOin`	supplierOin	Tekenreeks	Ja	-
`request.query.boardId`	boardId	Tekenreeks	Ja	-
`request.query.ecosystem`	ecosystem	Keuzelijst	Ja	-
`request.query.data_services`	data_services	Keuzelijst	Nee	-
`response.200`	response 200	Object	Nee	-
`response.200.supplierOin`	supplierOin	Tekenreeks	Ja	-
`response.200.boardId`	boardId	Tekenreeks	Ja	-
`response.200.ecosystem`	ecosystem	Tekenreeks	Ja	-
`response.200.dataServices`	dataServices	Lijst[]	Nee	-
`response.200.dataServices[*]`	dataServices	Object	Nee	-
`response.200.valid`	valid	Boolean	Ja	-
`response.400`	response 400 Functional status code and status message.	Object	Nee	-
`response.400.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.400.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.403`	response 403 Functional status code and status message.	Object	Nee	-
`response.403.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.403.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.404`	response 404 Functional status code and status message.	Object	Nee	-
`response.404.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.404.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-

Verwachte statuscodes

4 items

Code	Betekenis	Uitkomst
`200`	OK.	Succes
`400`	Bad Request	Fout
`403`	You are not allowed to view any agreement for the requested school board based on a data processing agreement	Fout
`404`	Not Found	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /agreements:
    get:
      summary: GET AgreementVerification for School Board and Supplier
      description: |-
         Use this API endpoint to find out if a school board has a data processing agreement with another supplier.
         
         When the requester is not allowed to request this information for this school board then you will get a 403.
         When the requester is allowed to request this information then the agreement verification data is returned (200).
      tags:
        - Verwerkersregister
      parameters:
        - name: supplierOin
          in: query
          allowEmptyValue: false
          required: true
          description: OIN of the system supplier
          schema:
            type: string
            pattern: (\d|\D){20}
        - name: boardId
          in: query
          allowEmptyValue: false
          required: true
          description: ID of the school board (Onderwijsbestuursnummer)
          schema:
            type: string
        - name: ecosystem
          in: query
          allowEmptyValue: false
          required: true
          description: The name of the Ecosystem to which the Data Processing Agreement must apply to.
          schema:
            type: string
            enum:
              - Edu-V
        - name: data_services
          in: query
          required: false
          description: The names of the Data services to which the Data Processing Agreement must apply to.
          schema:
            type: array
            items:
              type: string
              enum:
                - Onderwijsaanbod
                - Onderwijsinrichting
                - Onderwijsdeelnemers
                - Onderwijsmedewerkers
                - Leveringsorders
                - Aanspraken
                - Leermiddelgebruik
                - Leermateriaalgebruik
                - Leerresultaten
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementVerification'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
          description: Bad Request
        '403':
          description: You are not allowed to view any agreement for the requested school board based on a data processing agreement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
      security:
        - OAuth2:
            - eduv.dpa