/usage/school - Usage (P) - Edu-V Compliance Testlab

Veldspecificaties

24 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.orgMasterId`	orgMasterId	Tekenreeks	Nee	-
`request.query.orgId`	orgId	Tekenreeks	Nee	-
`request.query.orgIdType`	orgIdType	Keuzelijst	Nee	-
`response.200`	response 200	Object	Nee	-
`response.200.deliveryOrderId`	deliveryOrderId The deliveryOrderId which was part of the DeliveryOrder request send by the `Bestelomgeving leermiddelen` to the `Aanspraakmanager` and from the `Aanspraakmanager to the Licentieregistratie.	Tekenreeks	Ja	-
`response.200.totalEntitled`	totalEntitled Total number of entitlements that are entitled to users.	Geheel getal	Nee	-
`response.200.totalLicensed`	totalLicensed Total number of entitlements that are licensed to users.	Geheel getal	Nee	-
`response.200.totalCancelled`	totalCancelled Total number of entitlements that are cancelled for users.	Geheel getal	Nee	-
`response.200.totalBlocked`	totalBlocked Total number of entitlements that are blocked for users.	Geheel getal	Nee	-
`response.200.totalExpired`	totalExpired Total number of entitlements that are expired for users.	Geheel getal	Nee	-
`response.200.entitlements`	entitlements The entitlements which are registered on the Contract. For each `licensed` entitlement, the `Licentieregistratie` has send an InitialActivation event.'	Lijst[]	Ja	-
`response.200.entitlements[*]`	entitlements The entitlements which are registered on the Contract. For each `licensed` entitlement, the `Licentieregistratie` has send an InitialActivation event.'	Object	Nee	-
`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 - Licentieregistratie is provider of this endpoint	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /usage/school:
    parameters:
      - schema:
          type: string
        name: orgMasterId
        in: query
        required: false
        description: |
          The organisationMasterIdentifier of the school.
          This parameter is used when the primary identifier for a school (being the `OnderwijsaanbiederId`) is available.
      - schema:
          type: string
        name: orgId
        in: query
        required: false
        description: |
          The organisationIdentifier (secondary identifier) of the school.
          This parameter is used in combination with the orgIdType when the organisationMasterIdentifier is not available.
      - schema:
          type: string
          example: DD_ID
          enum:
            - OIE_CODE
            - BP_ID
            - DD_ID
            - AS_ID
        name: orgIdType
        in: query
        required: false
        description: |
          The type of the organisationIdentifier.
          This parameter is used in combination with the orgId when the organisationMasterIdentifier is not available.
    get:
      summary: Get Usage for School
      operationId: get-usage-for-school
      tags:
        - Licentieregistratie
      x-tags:
        - InitialActivation
        - Usage
        - Entitlement
        - DeliveryOrder
      description: |
        Retrieve all Usage information from a single School.
        Moreover, information from the DeliveryOrders and Entitlements is added to create a reporting overview of quantities entitled, licensed, and used.
        
        This endpoint is available for the `Leermiddelendashboard`. Consent is required for exchange of usage information from the 'Licentieregistratie' to the `Leermiddelendashboard`.

        The `Licentieregistratie` is the provider of this endpoint.
        The `Aanspraakmanager` should give a 405 HTTP status as result when called.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryOrderUsage'
        '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 - Licentieregistratie is provider of this endpoint
      security:
        - OAuth2:
            - eduv.usage.dashboard