PUT

/deliveryorders

Terug naar Delivery

Veldspecificaties

26 items
Veld Beschrijving Type Verplicht Beperkingen
response.
response
Object Nee -
response..deliveryOrderReferenceId
deliveryOrderReferenceId

Unique deliveryOrderReferenceId for this request. This referenceId is used by the Event Mediator of the Bestelomgeving leermiddelen to match the deliveryOrderConfirmation conformation message(s) send by the Aanspraakmanager. If a party receives another request with the same deliveryOrderReferenceId value, the receiving party should not process the event again. It should send the confirmation again.

 Tekenreeks Ja -
response..deliveryOrder
deliveryOrder
 Object Ja DeliveryOrder
response..deliveryOrder.deliveryOrderId
deliveryOrderId

The deliveryOrderId for the DeliveryOrder.

 Tekenreeks Ja -
response..deliveryOrder.contractId
contractId

An optional unique identifier for a contract between the supplier that is responsible for the Bestelomgeving leermiddelen and the supplier of the learning materials. The DeliveryOrder should be handled according to the business rules of the contract.

 Tekenreeks Nee -
response..deliveryOrder.buyer
buyer
 Object Ja Buyer
response..deliveryOrder.productId
productId

Unique identifier of a Product. The productId can be retrieved from the Catalogue API of supplier of the learning materials.

 Tekenreeks Ja -
response..deliveryOrder.deliveryType
deliveryType

The delivery type specifies the variant of the authorization rule an Aanspraakmanager should apply to manage activation and licensing of the Product.

 Keuzelijst Ja toegestaan ["school-all","school-admin","school-studies","school-subjects","school-groups","school-students","school-employees","school-activationcodes","customer-user","customer-activatoncode"]
response..deliveryOrder.deliverySpecification
deliverySpecification
 Object Ja DeliverySpecification
response..deliveryOrder.portals
portals

Leermiddelenportaal applications where the accessUrl needs to be processed.

 Lijst[] Nee -
response..deliveryOrder.portals[*]
portals

Leermiddelenportaal applications where the accessUrl needs to be processed.

 Object Nee -
response..deliveryOrder.startDate
startDate

Date from which the product can be activated by the Users. The startDate marks the start of the activation period. Format: YYYY-MM-DD (according to RFC3339).

 Datum Ja -
response..deliveryOrder.activationUntilDate
activationUntilDate

Date on which the product can no longer be activated by the Users. The activationUntilDate marks the end of the activation period. This does not imply the product can not be used by Licensees who have activated the product during the activation period. Format: YYYY-MM-DD (according to RFC3339).

 Datum Ja -
response..deliveryOrder.endDate
endDate

Date this DeliveryOrder was cancelled. Mandatory field when the status changes to cancelled. Format: YYYY-MM-DD (according to RFC3339).

 Datum Nee -
response..deliveryOrder.status
status

The status of the deliveryOrder. - Ordered: the delivery order is send to the Aanspraakmanager - Processed: the delivery order is processed by the Aanspraakmanager - Licensed: the product has been activated by at least one user. - Cancelled: the delivery order is cancelled by the Bestelomgeving leermiddelen

 Keuzelijst Ja toegestaan ["school-all","school-admin","school-studies","school-subjects","school-groups","school-students","school-employees","school-activationcodes","customer-user","customer-activatoncode"]
response..deliveryOrder.dateCreated
dateCreated

Indicates the date and time the object was first created. Format: Conform openapi in ZULU time zoals gespecificeerd in RFC 3339, section 5.6.

 Datum/tijd Ja -
response..deliveryOrder.dateLastModified
dateLastModified

Indicates the date and time the object was last modified. Format: Conform openapi in ZULU time zoals gespecificeerd in RFC 3339, section 5.6.

 Datum/tijd Ja -
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 providers of this endpoint Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

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