/consent/statuses/school - Consent (P) - Edu-V Compliance Testlab

Veldspecificaties

30 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.orgMasterId`	orgMasterId	Tekenreeks	Nee	-
`request.query.orgId`	orgId	Tekenreeks	Nee	-
`request.query.orgIdType`	orgIdType	Keuzelijst	Nee	-
`request.query.api`	api	Keuzelijst	Nee	-
`request.query.since`	since	Tekenreeks	Nee	-
`request.query.providerReferenceId`	providerReferenceId	Tekenreeks	Nee	-
`request.query.consumerReferenceId`	consumerReferenceId	Tekenreeks	Nee	-
`response.200`	response 200	Object	Nee	-
`response.200.providerReferenceId`	providerReferenceId Unique reference Id of this consent, as generated by the Data Provider. Example: `Administratiesysteem onderwijsdeelnemer` is Data Provider of SIS-data. Value is empty in case the ConsentRequest has not been confirmed yet.	Tekenreeks	Ja	-
`response.200.consumerReferenceId`	consumerReferenceId Unique reference Id of this consent, as generated by the Data Consumer. Example: `Aanspraakmanager`, `Gebruiksomgeving digitaal leermateriaal`, `Digitaal toetssysteem` or `Leermiddelendashboard` are examples of Data Consumers of SIS-data. Value is empty in case the Consent has not been confirmed yet.	Tekenreeks	Nee	-
`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 registered.	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.providerStatus`	providerStatus The status of the consent for the api and school 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.200.consumerStatus`	consumerStatus The current status of the consent for the api and school 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
`200`	'In the responses the most recent consent is included for which a consent is registered at the Data Provider or Data Consumer.'	Succes
`400`	Bad Request	Fout
`401`	Unauthorized	Fout
`404`	Not Found	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /consent/statuses/school:
    parameters:
      - schema:
          type: string
        name: orgMasterId
        in: query
        required: false
        description: |
          The organisationMasterIdentifier of the school.
          This parameter is used when the primary identifier for a school (being the `OnderwijsaanbiederId`) is available.
      - schema:
          type: string
        name: orgId
        in: query
        required: false
        description: |
          The organisationIdentifier (secondary identifier) of the school.
          This parameter is used in combination with the orgIdType when the organisationMasterIdentifier is not available.
      - schema:
          type: string
          example: DD_ID
          enum:
            - OIE_CODE
            - BP_ID
            - DD_ID
            - AS_ID
        name: orgIdType
        in: query
        required: false
        description: |
          The type of the organisationIdentifier.
          This parameter is used in combination with the orgId when the organisationMasterIdentifier is not available.
      - 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 status.'
      - schema:
          type: string
          format: date-time
        in: query
        name: since
        required: false
        description: 'Request all consentstatus 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"
      - schema:
          type: string
        name: providerReferenceId
        in: query
        required: false
        description: 'Optional providerReferenceId of the Consent registration.'
      - schema:
          type: string
        name: consumerReferenceId
        in: query
        required: false
        description: 'Optional consumerReferenceId of the Consent registration.'
    get:
      summary: 'GET ConsentStatuses by School'
      operationId: get-consent-statuses-by-school
      x-tags:
        - Consent
      tags:
        - Consent API Bron
        - Consent API Afnemer
        - Consent API Verzender
        - Consent API Ontvanger
      description: 'Retrieve the most recent consent registered for a specified `school` and `api`. Alternatively a `providerReferenceId` and/or `consumerReferenceId` can be included in the query to retrieve the status of a specific consent registration.'
      responses:
        '200':
          description: 'In the responses the most recent consent is included for which a consent is registered at the Data Provider or Data Consumer.'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConsentStatus'
        '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