/deliveryorders/confirmations - Delivery (P)

Veldspecificaties

20 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`response.`	response	Object	Nee	-
`response..deliveryOrderReferenceId`	deliveryOrderReferenceId The deliveryOrderReferenceId that was send by the `Bestelomgeving leermiddelen` as part of the DeliveryOrder request	Tekenreeks	Ja	-
`response..deliveryOrderReceiveId`	deliveryOrderReceiveId A reference to this confirmation message send by the `Aanspraakmanager` to the `Bestelomgeving leermiddelen`.	Tekenreeks	Ja	-
`response..deliveryOrderId`	deliveryOrderId The deliveryOrderId which was part of the DeliveryOrder request send by the `Bestelomgeving leermiddelen`.	Tekenreeks	Ja	-
`response..productId`	productId The productId which was part of the DeliveryOrder request send by the `Bestelomgeving leermiddelen`	Tekenreeks	Ja	-
`response..processedTimestamp`	processedTimestamp The moment that the DeliveryOrder request was processed by the `Aanspraakmanager` 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 `Aanspraakmanager` to the `Bestelomgeving leermiddelen`. Format: Conform openapi in ZULU time as specified in RFC 3339, section 5.6	Datum/tijd	Ja	-
`response..newStatus`	newStatus Confirmation of the next proposed status. Example: as a reply to a ordered status in a DeliveryOrder Event, the `Aanspraakmanager` can reply with a processed status to the `Bestelomgeving leermiddelen`.	Keuzelijst	Nee	toegestaan ["ordered","processed","licensed","cancelled"]
`response..newTotalQuantity`	newTotalQuantity `Aanspraakmanager` can confirm the new total quantity, as provided in the DeliveryOrder request by the `Bestelomgeving leermiddelen` to the `Aanspraakmanager`.	Geheel getal	Nee	-
`response..success`	success Boolean indicating the DeliveryOrder request was processed successfully. When the `Aanspraakmanager` disagrees with a certain change (e.g. status cancelled) a false will be returned, along with a status code and a status message.	Boolean	Ja	-
`response..status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response..statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`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 - Bestelomgeving leermiddelen is provider of this endpoint	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /deliveryorders/confirmations:
    put:
      summary: Confirm DeliveryOrder to Bestelomgeving leermiddelen
      operationId: confirm-delivery-order
      tags:
        - Bestelomgeving leermiddelen
      x-tags:
        - DeliveryOrder
      description: |
        As a `Aanspraakmanager` confirm a DeliveryOrder to the `Bestelomgeving leermiddelen`.
        
        The `Bestelomgeving leermiddelen` is the provider of this endpoint. 
        The `Aanspraakmanager` should give a 405 HTTP status as result when called.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryOrderConfirmation'
      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 - Bestelomgeving leermiddelen is provider of this endpoint
      security:
        - OAuth2:
            - eduv.delivery.entitlor