/subscribe/{api} - Notifications (P) - Edu-V Compliance Testlab

Veldspecificaties

7 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.api`	api	Keuzelijst	Ja	-
`response.400`	response 400 Functional status code and status message.	Object	Nee	-
`response.400.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.400.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.401`	response 401 Functional status code and status message.	Object	Nee	-
`response.401.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.401.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-

Verwachte statuscodes

3 items

Code	Betekenis	Uitkomst
`200`	OK	Succes
`400`	Bad Request	Fout
`401`	Unauthorized	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /subscribe/{api}:
    parameters:
      - schema:
          type: string
          enum:
            - 'education-api'
            - 'association-api'
            - 'students-api'
            - 'employees-api'
            - 'catalogue-api'
            - 'course-api'
        name: api
        in: path
        required: true
        description: 'API to which the Consumer wants to subscribe.'
    post:
      summary: 'Subscribe to notifications for new/modified/deleted data objects from an API'
      operationId: subscribe
      x-tags:
        - Notification
      tags:
        - Producer
      description: |
        Subscribe to notifications from a specified API.
        The Producer registers the Consumer as one of the subscribers to changes in the requested API.
        This includes all data objects from schools for which the Consumer has an active consent with the Producer.'
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
      security:
        - OAuth2:
            - eduv.catalogue
            - eduv.course
            - eduv.education
            - eduv.association
            - eduv.student.basic
            - eduv.student.demographics
            - eduv.student.communication
            - eduv.student.accessibility
            - eduv.student.deliveryaddress
            - eduv.employee.basic
            - eduv.employee.communication
            - eduv.employee.roles