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

Veldspecificaties

44 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`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.school`	school	Object	Ja	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	Object	Ja	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.totalEntitled`	totalEntitled Total number of entitlements that are entitled for this user.	Geheel getal	Nee	-
`response.200.totalLicensed`	totalLicensed Total number of entitlements that are licensed for this users.	Geheel getal	Nee	-
`response.200.totalCancelled`	totalCancelled Total number of entitlements that are cancelled for this users.	Geheel getal	Nee	-
`response.200.totalBlocked`	totalBlocked Total number of entitlements that are blocked for this users.	Geheel getal	Nee	-
`response.200.totalExpired`	totalExpired Total number of entitlements that are expired for this users.	Geheel getal	Nee	-
`response.200.entitlements`	entitlements An array of all entitlements for the Student or Employee.	Lijst[]	Ja	-
`response.200.entitlements[*]`	entitlements An array of all entitlements for the Student or Employee.	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/user:
    post:
      summary: Get Usage for User at School
      operationId: get-usage-for-user-at-school
      tags:
        - Licentieregistratie
      x-tags:
        - InitialActivation
        - Usage
        - Entitlement
      description: |
        Retrieve all Usage information from a single Student or Employee at a school.
        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 for all entitlements of a single Student or Employee from the `Licentieregistratie`.
        
        The `Licentieregistratie` is the provider of this endpoint.
        The `Aanspraakmanager` should give a 405 HTTP status as result when called.
        Consent is required for exchange of usage information from the 'Licentieregistratie' to the `Leermiddelendashboard`.
        
        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/SchoolUserUsage'
        '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