/entitlements/confirmations - Entitlement (P)

Veldspecificaties

20 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`response.`	response	Object	Nee	-
`response..entitlementReferenceId`	entitlementReferenceId The entitlementReferenceId that was send by the `Aanspraakmanager` as part of the Entitlement request	Tekenreeks	Ja	-
`response..entitlementReceiveId`	entitlementReceiveId A reference to this confirmation message send by the `Licentieregistratie` or the `Leermiddelenportaal` to the `Aanspraakmanager`.	Tekenreeks	Ja	-
`response..entitlementId`	entitlementId The entitlementId which was part of the Entitlement request send by the `Aanspraakmanager`.	Tekenreeks	Ja	-
`response..productId`	productId The productId which was part of the Entitlement request send by the `Aanspraakmanager`	Tekenreeks	Ja	-
`response..processedTimestamp`	processedTimestamp The moment that the Entitlement request was processed by the `Licentieregistratie` or the `Leermiddelenportaal` and the change became effective. As requests and confirmation messages are send asynchronous, this is not the moment the confirmation message was send by the `Licentieregistratie` or the `Leermiddelenportaal` to the `Aanspraakmanager`. Format: Conform openapi in ZULU time as specified in RFC 3339, section 5.6	Datum/tijd	Ja	-
`response..newEntitlementStatus`	newEntitlementStatus Confirmation of the proposed status. Example: as a reply to a created status in an Entitlement request, a `Licentieregistratie` can reply with an entitled status to the `Aanspraakmanager`.	Keuzelijst	Nee	toegestaan ["created","entitled","licensed","cancelled","blocked"]
`response..newUrlStatus`	newUrlStatus Confirmation of the processing of the request. Example: as a reply to a initialized status in an Entitlement request, the `Leermiddelenportaal` application can reply with a processed status to the `Aanspraakmanager`.	Object	Nee	-
`response..portal`	portal Identifier of the `Leermiddelenportaal` application.	Tekenreeks	Nee	-
`response..urlStatus`	urlStatus	Keuzelijst	Nee	toegestaan ["initialized","processed","cancelled","blocked","expired"]
`response..urlStatus`	urlStatus	Keuzelijst	Nee	toegestaan ["initialized","processed","cancelled","blocked","expired"]
`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.403`	response 403 Functional status code and status message.	Object	Nee	-
`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

5 items

Code	Betekenis	Uitkomst
`202`	Accepted	Succes
`400`	Bad Request	Fout
`401`	Unauthorized	Fout
`403`	Forbidden	Fout
`405`	Method Not Allowed - Aanspraakmanager is provider of this endpoint	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /entitlements/confirmations:
    put:
      summary: Confirm Entitlement to Aanspraakmanager
      operationId: confirm-entitlement
      tags:
        - Aanspraakmanager
      x-tags:
        - Entitlement
      description: |
        As a `Licentieregistratie` or `Leermiddelenportaal` confirm an Entitlement to the `Aanspraakmanager`.
        
        The `Aanspraakmanager` is the provider of this endpoint. 
        The `Licentieregistratie` and `Leermiddelenportaal` should give a 405 HTTP status as result when called.
        Consent is required for exchange of entitlement information from the 'Aanspraakmanager' to the `Leermiddelenportaal`.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitlementConfirmation'
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '405':
          description: Method Not Allowed - Aanspraakmanager is provider of this endpoint
      security:
        - OAuth2:
            - eduv.entitlement.licensor
            - eduv.entitlement.portal