/creditorders/confirmations - Order (P) - Edu-V Compliance Testlab

Veldspecificaties

28 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 The requestReferenceId that was send by the `Bestelomgeving leermiddelen` as part of the CreditOrderRequest request	Tekenreeks	Ja	-
`response.405.responseReferenceId`	responseReferenceId A reference to this confirmation message send by the `Ordersysteem leermiddelen` to the `Bestelomgeving leermiddelen`.	Tekenreeks	Ja	-
`response.405.purchaseOrderId`	purchaseOrderId Purchase order number of the order to be credited as defined by the `Bestelomgeving leermiddelen`. This number is linked to the financial system of the `Bestelomgeving leermiddelen`.	Tekenreeks	Ja	-
`response.405.salesOrderId`	salesOrderId Sales order number of the order to be credited as defined by the `Ordersysteem leermiddelen`. This number is linked to the financial system of the `Ordersysteem leermiddelen`.	Tekenreeks	Nee	-
`response.405.salesOrderLineId`	salesOrderLineId Optional line number in case of an order with more than one product.	Tekenreeks	Nee	-
`response.405.processedTimestamp`	processedTimestamp The moment that the credit order was processed by the `Ordersysteem leermiddelen`. As requests and confirmation messages are send asynchronous, this is not the moment the confirmation message was send by the `Ordersysteem leermiddelen` to the `Bestelomgeving leermiddelen`. Format: openapi in ZULU time as specified in RFC 3339, section 5.6	Datum/tijd	Ja	-
`response.405.creditOrderStatus`	creditOrderStatus The status of pending allows the `Ordersysteem leermiddelen` to communicate to the `Bestelomgeving leermiddelen` that the approval process has started, but has not yet been completed.	Keuzelijst	Ja	toegestaan ["pending","approved","declined"]
`response.405.success`	success Boolean indicating the CreditOrderRequest was processed successfully. When the `Ordersysteem leermiddelen` declines the request a false will be returned, along with a status code and a status message.	Boolean	Ja	-
`response.405.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.405.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.405.creditOrderConfirmationLines`	creditOrderConfirmationLines	Lijst[]	Nee	-
`response.405.creditOrderConfirmationLines[*]`	creditOrderConfirmationLines	Object	Nee	-
`response.405.creditOrderConfirmationLines[*].purchaseOrderLineId`	purchaseOrderLineId Reference to the `purchaseOrderLineId` that has been cancelled.	Tekenreeks	Nee	-
`response.405.creditOrderConfirmationLines[*].salesOrderLineId`	salesOrderLineId Reference to the `salesOrderLineId` that has been cancelled.	Tekenreeks	Nee	-
`response.405.creditOrderConfirmationLines[*].productId`	productId Echo of the `productId` from the CreditOrderRequest for confirmation.	Tekenreeks	Ja	-
`response.405.creditOrderConfirmationLines[*].quantity`	quantity Echo of the `quantity` from the CreditOrderRequest for confirmation.	Geheel getal	Nee	-
`response.405.creditOrderConfirmationLines[*].status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.405.creditOrderConfirmationLines[*].statusMessage`	statusMessage See functional status codes 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.

  /creditorders/confirmations:
    put:
      summary: Confirm credit order request
      operationId: confirm-credit-order-request
      tags:
        - Bestelomgeving leermiddelen
      x-tags:
        - Order
      description: |-
        As a `Ordersysteem leermiddelen` confirm the CreditOrderRequest to the `Bestelomgeving leermiddelen`.
        
        The `Bestelomgeving leermiddelen` is the provider of this endpoint. 
        The `Ordersysteem 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 - Bestelomgeving leermiddelen is provider of this endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditOrderConfirmation'
      security:
        - OAuth2:
            - eduv.order