PUT

/consent/revokes

Revoke request for a specified consent registration.

Terug naar Consent

Veldspecificaties

23 items
Veld Beschrijving Type Verplicht Beperkingen
response.
response

A model that describes a consent revoke from the Data Consumer or the Data Provider.

 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.

 Tekenreeks Ja -
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 revoked.

 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 revoked for the consent registration at the Data Provider.

 Keuzelijst Nee toegestaan ["students-api","employees-api","education-api","association-api","delivery-api","entitlement-api","usage-api","progress-api","results-api"]
response..consumerStatus
consumerStatus

The status revoked for the consent registration at the Data Consumer.

 Keuzelijst Nee 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 Consent Revoke 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/revokes:
    put:
      summary: 'PUT a ConsentRevoke to Data Provider or Data Consumer'
      operationId: put-consent-revoke
      x-tags:
        - Consent
      tags:
        - Consent API Bron
        - Consent API Afnemer
        - Consent API Verzender
        - Consent API Ontvanger
      description: 'This endpoint is offered by both the Data Provider and the Data Consumer to receive revoke requests for consents.'
      requestBody:
        description: 'Revoke request for a specified consent registration.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentRevoke'
      responses:
        '202':
          description: 'The Consent Revoke 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