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

Veldspecificaties

20 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 CreditOrderConfirmation confirmation message(s) send by the `Ordersysteem leermiddelen`. 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.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.responseReferenceId`	responseReferenceId "Optional reference to the responseReferenceID of the confirmation message in which the `Ordersysteem leermiddelen` approved the order to the `Bestelomgeving leermiddelen`."	Tekenreeks	Nee	-
`response.405.orderLines`	orderLines Optional specification of the products in the OrderRequest to be be cancelled.	Lijst[]	Nee	-
`response.405.orderLines[*]`	orderLines Optional specification of the products in the OrderRequest to be be cancelled.	Object	Nee	-
`response.405.orderLines[*].purchaseOrderLineId`	purchaseOrderLineId Optional reference to the `purchaseOrderLineId` of the OrderRequest for the product to be cancelled.	Tekenreeks	Nee	-
`response.405.orderLines[*].salesOrderLineId`	salesOrderLineId Optional reference to the `salesOrderLineId` of the OrderConfirmation for the product to be cancelled.	Tekenreeks	Nee	-
`response.405.orderLines[*].productId`	productId The Product that is to be cancelled.	Tekenreeks	Ja	-
`response.405.orderLines[*].quantity`	quantity The quantity of Product that is to be cancelled.	Geheel getal	Ja	-

Verwachte statuscodes

5 items

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

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /creditorders:
    put:
      summary: Accept credit order request
      operationId: accept-credit-order-request
      tags:
        - Ordersysteem leermiddelen
      x-tags:
        - Order
      description: |-
        As a `Bestelomgeving leermiddelen` place a CreditOrderRequest at the `Ordersysteem leermiddelen` to cancel an earlier OrderRequest to purchase learning materials.
        
        The `Ordersysteem leermiddelen` 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 - Ordersysteem leermiddelen is provider of this endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditOrderRequest'
      security:
        - OAuth2:
            - eduv.order