/consent/notifications - Consent (P) - Edu-V Compliance Testlab

Veldspecificaties

22 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`response.`	response A model that describes the consent registration or the approval of a consent request from the Data Provider. The consent notification is send by the Data Provider to the Data Consumer.	Object	Nee	-
`response..providerReferenceId`	providerReferenceId Unique reference Id of this consent, as generated by the Data Provider.	Tekenreeks	Ja	-
`response..consumerReferenceId`	consumerReferenceId Unique reference Id of this consent, as generated by the Data Consumer. In case this notification is a reply to an earlier ConsentRequest, the consumerReferenceId from the ConsentRequest is included.	Tekenreeks	Nee	-
`response..school`	school The School for which consent is registered.	Object	Ja	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..api`	api The API for which consent is registered.	Keuzelijst	Ja	toegestaan ["students-api","employees-api","education-api","association-api","delivery-api","entitlement-api","usage-api","progress-api","results-api"]
`response..scopes`	scopes	Lijst[]	Ja	-
`response..scopes[*]`	scopes	Object	Nee	-
`response..providerStatus`	providerStatus The status of the consent registration at the Data Provider.	Keuzelijst	Ja	toegestaan ["students-api","employees-api","education-api","association-api","delivery-api","entitlement-api","usage-api","progress-api","results-api"]
`response.400`	response 400 Functional status code and status message.	Object	Nee	-
`response.400.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.400.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.401`	response 401 Functional status code and status message.	Object	Nee	-
`response.401.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.401.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.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
`202`	'The ConsentNotification is accepted and will be processed.'	Succes
`400`	Bad Request	Fout
`401`	Unauthorized	Fout
`404`	Not Found	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /consent/notifications:
    put:
      summary: 'PUT a ConsentNotification to Data Consumer'
      operationId: put-consent-notification
      x-tags:
        - Consent
      tags:
        - Consent API Afnemer
        - Consent API Ontvanger
      description: 'This endpoint is offered by the Data Consumer and allows Data Providers to notify the Data Consumer of a new consent registration.'
      requestBody:
        description: 'Update of consent for a school, api, and scope from the Data Provider.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentNotification'
      responses:
        '202':
          description: 'The ConsentNotification is accepted and will be processed.'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
      security:
        - OAuth2:
            - eduv.consent