/activationcodes - ActivationCode (P) - Edu-V Compliance Testlab

Veldspecificaties

14 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`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	-
`response.405`	response 405	Object	Nee	-
`response.405.requestReferenceId`	requestReferenceId Unique requestReferenceId for this request. This referenceId is used by the Event Mediator of the `Bestelomgeving leermiddelen` to match the ActivationCodeConfirmation confirmation message(s) send by the `Licentieregistratie`. If a party receives another request with the same requestReferenceId value, the receiving party should not process the request again. It should send the confirmation again.	Tekenreeks	Ja	-
`response.405.productId`	productId The Product for which a `Bestelomgeving leermiddelen` requests (an) activation code(s). The productId can be retrieved from the Catalogue API from the supplier of the learning material.	Tekenreeks	Ja	-
`response.405.quantity`	quantity Total requested activation codes for the Product.	Geheel getal	Ja	-
`response.405.contractId`	contractId An optional unique identifier for a contract between the two suppliers where this requests belongs to.	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 - Licentieregistratie is provider of this endpoint	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /activationcodes:
    put:
      summary: Accept activation code request
      operationId: accept-activation-code-request
      tags:
        - Licentieregistratie
      x-tags:
        - ActivationCode
      description: |-
        As a `Bestelomgeving leermiddelen` request an activation code from the `Licentieregistratie`.
        
        The `Licentieregistratie` is the provider of this endpoint.
        The `Bestelomgeving leermiddelen` should give a 405 HTTP status as result when called.
      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 - Licentieregistratie is provider of this endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivationCodeRequest'
      security:
        - OAuth2:
            - eduv.activationcode