/deliveryorders/{id} - Delivery (P) - Edu-V Compliance Testlab

Veldspecificaties

25 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.id`	id	Tekenreeks	Ja	-
`response.200`	response 200	Object	Nee	-
`response.200.deliveryOrderId`	deliveryOrderId The deliveryOrderId for the DeliveryOrder.	Tekenreeks	Ja	-
`response.200.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.200.buyer`	buyer	Object	Ja	Buyer
`response.200.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.200.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.200.deliverySpecification`	deliverySpecification	Object	Ja	DeliverySpecification
`response.200.portals`	portals `Leermiddelenportaal` applications where the accessUrl needs to be processed.	Lijst[]	Nee	-
`response.200.portals[*]`	portals `Leermiddelenportaal` applications where the accessUrl needs to be processed.	Object	Nee	-
`response.200.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.200.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.200.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.200.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.200.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.200.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.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.404`	response 404 Functional status code and status message.	Object	Nee	-
`response.404.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.404.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-

Verwachte statuscodes

6 items

Code	Betekenis	Uitkomst
`200`	OK	Succes
`400`	Bad Request	Fout
`401`	Unauthorized	Fout
`403`	Forbidden	Fout
`404`	Not Found	Fout
`405`	Method not allowed - Bestelomgeving leermiddelen is provider of this endpoint	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /deliveryorders/{id}:
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: 'Specific deliveryOrderId of a DeliveryOrder.'
    get:
      summary: Get DeliveryOrder
      operationId: get-delivery-order
      tags:
        - Bestelomgeving leermiddelen
      x-tags:
        - DeliveryOrder
      description: |
        Retrieve a DeliveryOrder by ID from a `Bestelomgeving leermiddelen`.
        Consent is required for a `Leermiddelendashboard` to request this information.
        
        The `Bestelomgeving leermiddelen` is the provider of this endpoint.
        The `Aanspraakmanager` should give a 405 HTTP status as result when called.

        This endpoint can be used by the `Licentieregistratie` to request detailed information about a DeliveryOrder, including:
        - DeliveryType: especially useful in the case of an open deliveryType.
        - TotalQuantity: the total quantity at the time of the purchase by the Buyer. This value can also be used within the usage reporting in the Usage API.
        - Buyer: what school or individual bought the product.

        This endpoint can be used by the `Aanspraakmanager` and `Licentieregistratie` for support processes.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryOrder'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '404':
          description: Not Found
          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
            - eduv.delivery.licensor
            - eduv.delivery.dashboard
            - eduv.delivery.portal