/notification - Notifications (P) - Edu-V Compliance Testlab

Veldspecificaties

30 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`response.`	response \|-	Object	Nee	-
`response..id`	id Unique identifier for this Notification.	Tekenreeks	Ja	-
`response..notificationType`	notificationType	Keuzelijst	Ja	toegestaan ["object","bulk"]
`response..objectType`	objectType The type of object that has changed.	Keuzelijst	Ja	toegestaan ["object","bulk"]
`response..objectId`	objectId Unique identifier of the object sent within this notification.	Tekenreeks	Nee	-
`response..school`	school	Object	Nee	SchoolReference
`response..school.organisationMasterIdentifier`	organisationMasterIdentifier The primary identifier for a School. For Schools the `OnderwijsaanbiederId` is used. (either organisationMasterIdentifier or organisationIds is required)	Tekenreeks	Nee	-
`response..school.organisationIds`	organisationIds A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)	Lijst[]	Nee	-
`response..school.organisationIds[*]`	organisationIds A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)	Object	Nee	-
`response..school.organisationIds[*].organisationId`	organisationId	Tekenreeks	Ja	-
`response..school.organisationIds[*].organisationIdType`	organisationIdType	Keuzelijst	Ja	toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID"]
`response..created`	created The moment that the action happened which triggered this notification. As Notifications are sent asynchronous, this is not the moment the Notification was sent. Format: openapi in ZULU time as specified in RFC 3339, section 5.6	Datum/tijd	Ja	-
`response..url`	url "The callback url to retrieve the modified object"	Tekenreeks	Nee	-
`response..isDeleteNotification`	isDeleteNotification Indication that this is the last notification you will ever see, as the object is deleted.	Boolean	Nee	-
`response.200`	response 200 The response for a single Notification given by the Consumer that received the Notification.	Object	Nee	-
`response.200.id`	id The identifier of the Notification where this response refers to.	Tekenreeks	Ja	-
`response.200.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.200.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.400`	response 400 The response for a single Notification given by the Consumer that received the Notification.	Object	Nee	-
`response.400.id`	id The identifier of the Notification where this response refers to.	Tekenreeks	Ja	-
`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 The response for a single Notification given by the Consumer that received the Notification.	Object	Nee	-
`response.401.id`	id The identifier of the Notification where this response refers to.	Tekenreeks	Ja	-
`response.401.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.401.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.403`	response 403 The response for a single Notification given by the Consumer that received the Notification.	Object	Nee	-
`response.403.id`	id The identifier of the Notification where this response refers to.	Tekenreeks	Ja	-
`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	-

Verwachte statuscodes

4 items

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

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /notification:
    post:
      summary: Receive one notification
      operationId: post-notification
      x-tags:
        - Notification
      tags:
        - Consumer
      description: |
        Endpoint to receive a single Notification as a Consumer from different Producers. For example a party with the reference component `Gebruiksomgeving digitaal leermateriaal` can receive notifications from all parties offering `Administratiesysteem onderwijsdeelnemer` reference components.
      requestBody:
        description: |
          The request body contains a single Notification.
          
          Notifications are processed asynchronous.
          In the request body a status code and message is included as a confirmation if the notifications are received in a correct format.
          All notifications are confirmed with a status ok (0), excluding notifications that have an invalid format or notifications that were sent in an invalid security scope or consent.
          See Documentation for functional status codes and messages.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Notification'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationResponse'
      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