/usage/entitlements/{id} - Usage (P) - Edu-V Compliance Testlab

Veldspecificaties

33 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.id`	id	Tekenreeks	Ja	-
`response.200`	response 200	Object	Nee	-
`response.200.entitlementId`	entitlementId The identifier of the Entitlement.	Tekenreeks	Ja	-
`response.200.productId`	productId Refers to a (bundled) product from the Entitlement.	Tekenreeks	Nee	-
`response.200.entitlementType`	entitlementType The entitlement type specifies if a student, employee or a user with an activation code can activate and license the product.	Keuzelijst	Ja	toegestaan ["school-student","school-employee","school-activationcode","customer-student","customer-activationcode"]
`response.200.entitlementStatus`	entitlementStatus The status of the Entitlement as registered by the `Licentieregistratie`.	Keuzelijst	Ja	toegestaan ["school-student","school-employee","school-activationcode","customer-student","customer-activationcode"]
`response.200.school`	school This value is mandatory if the entitlementType is school-student, school-employee or school-activationcode	Object	Nee	SchoolReference
`response.200.school.organisationMasterIdentifier`	organisationMasterIdentifier The primary identifier for a School. For Schools the `OnderwijsaanbiederId` is used. (either organisationMasterIdentifier or organisationIds is required)	Tekenreeks	Nee	-
`response.200.school.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.200.school.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.200.school.organisationIds[*].organisationId`	organisationId	Tekenreeks	Ja	-
`response.200.school.organisationIds[*].organisationIdType`	organisationIdType	Keuzelijst	Ja	toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID"]
`response.200.user`	user This value is mandatory if the entitlementType is school-student, school-employee or customer-student	Object	Nee	UserReference
`response.200.user.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.200.user.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.200.user.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.200.user.userIds[*].userId`	userId	Tekenreeks	Ja	-
`response.200.user.userIds[*].userIdType`	userIdType	Keuzelijst	Ja	toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"]
`response.200.activationCode`	activationCode This value is mandatory if the entitlementType is school-activationcode or customer-activationcode. The activation code as send by the `Aanspraakmanager` as part of the entitlement. In case the entitlementStatus is Licensed, the product is activated with the activation code. It is not able to use the activation code again.	Tekenreeks	Nee	-
`response.200.expirationDate`	expirationDate The expiration date of this entitlement. Format: YYYY-MM-DD (according to RFC3339).	Datum	Nee	-
`response.200.usage`	usage	Object	Nee	usage
`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/entitlements/{id}:
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
    get:
      summary: Get Usage by Entitlement
      operationId: get-usage-by-entitlement
      tags:
        - Licentieregistratie
      x-tags:
        - InitialActivation
        - Usage
        - Entitlement
      description: |
        Retrieve all Usage information from a single Entitlement.
        Moreover, information from the Entitlement is added to create a reporting overview of quantities entitled, licensed, and used.
        
        This information was already send to the `Aanspraakmanager` within InitialActivation messages.
        This endpoint is available for support reasons and allows these reference components to gather status information on an Entitlement from the `Licentieregistratie`.

        This endpoint is available for the `Bestelomgeving leermiddelen` and the `Aanspraakmanager`. No consent is required to receive the information.
        
        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/EntitlementUsage'
        '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.seller
            - eduv.usage.entitlor
            - eduv.usage.dashboard