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

Veldspecificaties

44 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.api`	api	Keuzelijst	Nee	-
`request.query.since`	since	Tekenreeks	Nee	-
`response.`	response A model that describes a consent request from the Data Consumer to the Data Provider.	Object	Nee	-
`response..consumerReferenceId`	consumerReferenceId Unique reference Id of this consent request, 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 requested.	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..consumerStatus`	consumerStatus The status accepted for the consent registration at the Data Consumer.	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	-
`response.200`	response 200 A model that describes a consent request from the Data Consumer to the Data Provider.	Object	Nee	-
`response.200.consumerReferenceId`	consumerReferenceId Unique reference Id of this consent request, as generated by the Data Consumer.	Tekenreeks	Ja	-
`response.200.school`	school The School for which consent is registered.	Object	Ja	SchoolReference
`response.200.school.organisationMasterIdentifier`	organisationMasterIdentifier The primary identifier for a School. For Schools the `OnderwijsaanbiederId` is used. (either organisationMasterIdentifier or organisationIds is required)	Tekenreeks	Nee	-
`response.200.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.200.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.200.school.organisationIds[*].organisationId`	organisationId	Tekenreeks	Ja	-
`response.200.school.organisationIds[*].organisationIdType`	organisationIdType	Keuzelijst	Ja	toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID"]
`response.200.api`	api The API for which consent is requested.	Keuzelijst	Ja	toegestaan ["students-api","employees-api","education-api","association-api","delivery-api","entitlement-api","usage-api","progress-api","results-api"]
`response.200.scopes`	scopes	Lijst[]	Ja	-
`response.200.scopes[*]`	scopes	Object	Nee	-
`response.200.consumerStatus`	consumerStatus The status accepted for the consent registration at the Data Consumer.	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

8 items

Code	Betekenis	Uitkomst
`202`	'The Consent Request is accepted and will be processed.'	Succes
`400`	Bad Request	Fout
`401`	Unauthorized	Fout
`404`	Not Found	Fout
`200`	'If the api path parameter is empty, the responses includes all apis for which consent requests are registered at the Data Consumer.'	Succes
`400`	Bad Request	Fout
`401`	Unauthorized	Fout
`404`	Not Found	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /consent/requests:
    put:
      summary: 'PUT a ConsentRequest to Data Provider'
      operationId: put-consent-request
      x-tags:
        - Consent
      tags:
        - Consent API Bron
        - Consent API Verzender
      description: 'This endpoint is offered by the Data Provider to receive consent requests.'
      requestBody:
        description: 'Request for a specified consent registration.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentRequest'
      responses:
        '202':
          description: 'The Consent Request 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
    get:
      summary: 'GET ConsentRequests from Data Consumer after a specified timestamp'
      operationId: get-consent-requests
      x-tags:
        - Consent
      tags:
        - Consent API Ontvanger
      description: 'This endpoint is offered by the Data Consumer to request all given consent requests.'
      parameters:
        - schema:
            type: string
            enum:
            - students-api
            - employees-api
            - education-api
            - association-api
            - delivery-api
            - entitlement-api
            - usage-api
            - progress-api
            - results-api
          name: api
          in: query
          required: false
          description: 'The API for which a party wants to retrieve the Consent Requests information.'
        - schema:
            type: string
            format: date-time
          in: query
          name: since
          required: false
          description: 'Request all consent requests information after the specified timestamp. Format: Conform openapi in ZULU time as specified in RFC 3339, section 5.6'
          example: "2017-07-21T17:32:28Z"
      responses:
        '200':
          description: 'If the api path parameter is empty, the responses includes all apis for which consent requests are registered at the Data Consumer.'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConsentRequest'
        '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