/deliveryorders/school/user - Delivery (P)

Veldspecificaties

40 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.status`	status	Keuzelijst	Nee	-
`response.`	response A reference to a School organisation.	Object	Nee	-
`response..organisationMasterIdentifier`	organisationMasterIdentifier The primary identifier for a School. For Schools the `OnderwijsaanbiederId` is used. (either organisationMasterIdentifier or organisationIds is required)	Tekenreeks	Nee	-
`response..organisationIds`	organisationIds A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)	Lijst[]	Nee	-
`response..organisationIds[*]`	organisationIds A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)	Object	Nee	-
`response..organisationIds[*].organisationId`	organisationId	Tekenreeks	Ja	-
`response..organisationIds[*].organisationIdType`	organisationIdType	Keuzelijst	Ja	toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID"]
`response.`	response	Object	Nee	-
`response..userMasterIdentifier`	userMasterIdentifier The primary identifier for a User. For Students the ECK iD is used. For Employees this value is empty. There is no primary identifier for Employees. (either userMasterIdentifier or userIds is required)	Tekenreeks	Nee	-
`response..userIds`	userIds A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)	Lijst[]	Nee	-
`response..userIds[*]`	userIds A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)	Object	Nee	-
`response..userIds[*].userId`	userId	Tekenreeks	Ja	-
`response..userIds[*].userIdType`	userIdType	Keuzelijst	Ja	toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"]
`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.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.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/school/user:
    parameters:
      - schema:
            type: string
            example: processed
            enum:
              - ordered
              - processed
              - licensed
              - cancelled
        name: status
        in: query
        description: 'Filter by status'
    post:
      summary: Get DeliveryOrders for User at School
      operationId: get-delivery-orders-for-user-at-school
      tags:
        - Bestelomgeving leermiddelen
      x-tags:
        - DeliveryOrder
      description: |
        Retrieve all DeliveryOrders for a specific user at a school from a `Bestelomgeving leermiddelen`.
        Consent is required for a `Leermiddelendashboard` and `Leermiddelenportaal` 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.
        
        Due to the confidentiality of the eckId and userIds this endpoint has been implemented as a POST endpoint where the confidential information is securely send within the request body.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                school:
                  $ref: '#/components/schemas/SchoolReference'
                user:
                  $ref: '#/components/schemas/UserReference'
              required:
                - school
                - user
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeliveryOrder'
        '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'
        '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.dashboard
            - eduv.delivery.portal