/entitlements/school - Entitlement (P) - Edu-V Compliance Testlab

Veldspecificaties

32 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.orgMasterId`	orgMasterId	Tekenreeks	Nee	-
`request.query.orgId`	orgId	Tekenreeks	Nee	-
`request.query.orgIdType`	orgIdType	Keuzelijst	Nee	-
`request.query.deliveryOrderId`	deliveryOrderId	Tekenreeks	Nee	-
`request.query.entitlementStatus`	entitlementStatus	Keuzelijst	Nee	-
`response.200`	response 200 The core object that expresses information about a product that is entitled by the `Aanspraakmanager` to a specified user or a user in possession of a specified activation code.	Object	Nee	-
`response.200.entitlementId`	entitlementId	Tekenreeks	Ja	-
`response.200.deliveryOrderId`	deliveryOrderId The deliveryOrderId which was part of the DeliveryOrder request send by the `Bestelomgeving leermiddelen` to the `Aanspraakmanager`.	Tekenreeks	Nee	-
`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.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.startDate`	startDate Date from which the product can be activated by the Entitlee(s). 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 Entitlee(s). 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.expirationDate`	expirationDate ExpirationDate a `Leermiddelenportaal` can use to maintain access links to the Product in the Learning Material Lists of Students or Employees. An initially set minExpirationDate is calculated by the `Aanspraakmanager` based on info from the Product retrieved from the Catalogue API. If the `Aanspraakmanager` receives an InitialActivation message regarding this Entitlement from the `Licentieregistratie` via the Usage API, the expirationDate could be updated. The InitialActivation message could include an updated expirationDate. In that case this new expirationDate overwrites the initially set minExpirationDate. This triggers the process within the `Aanspraakmanager` to exchange the updated entitlement with the `Leermiddelenportaal`. The urlStatus is updated to `initialized` and is newly exchanged with the `Leermiddelenportaal`. Format: YYYY-MM-DD (according to RFC3339).	Datum	Nee	-
`response.200.endDate`	endDate Date this Entitlement was blocked or cancelled. Mandatory field when the status changes to Cancelled or Blocked. Format: YYYY-MM-DD (according to RFC3339).	Datum	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.entitlementSpecification`	entitlementSpecification	Object	Nee	EntitlementSpecification
`response.200.entitlementStatus`	entitlementStatus The status of the entitlement.	Keuzelijst	Ja	toegestaan ["school-student","school-employee","school-activationcode","customer-student","customer-activationcode"]
`response.200.urlStatuses`	urlStatuses	Lijst[]	Nee	-
`response.200.urlStatuses[*]`	urlStatuses	Object	Nee	-
`response.200.urlStatuses[*].portal`	portal Identifier of the `Leermiddelenportaal` application.	Tekenreeks	Nee	-
`response.200.urlStatuses[*].urlStatus`	urlStatus The status of the accessUrl at the `Leermiddelenportaal` application.	Keuzelijst	Nee	toegestaan ["uninitialized","initialized","processed","cancelled","blocked"]
`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 - Aanspraakmanager is provider of this endpoint	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /entitlements/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.
      - schema:
            type: string
        name: deliveryOrderId
        in: query
        description: 'Filter by deliveryOrderId'
      - schema:
            type: string
            example: entitled
            enum:
              - created
              - entitled
              - licensed
              - cancelled
              - blocked
        name: entitlementStatus
        in: query
        description: 'Filter by entitlementStatus'
    get:
      summary: Get Entitlements for School
      operationId: get-entitlements-for-school
      tags:
        - Aanspraakmanager
      x-tags:
        - Entitlement
        - DeliveryOrder
      description: |
        Retrieve all entitlements for a specific school from a `Aanspraakmanager`.
        
        The `Aanspraakmanager` is the provider of this endpoint.
        
        The `Licentieregistratie` and `Leermiddelenportaal` should give a 405 HTTP status as result when called.
        Consent is required for exchange of entitlement information from the 'Aanspraakmanager' to the `Leermiddelenportaal` and the `Leermiddelendashboard`.
        
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Entitlement'
        '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 - Aanspraakmanager is provider of this endpoint
      security:
        - OAuth2:
            - eduv.entitlement.dashboard
            - eduv.entitlement.portal