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

Veldspecificaties

32 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`response.`	response	Object	Nee	-
`response..entitlementId`	entitlementId The Entitlement which included the right of the Student or Employee to activate the Product.	Tekenreeks	Ja	-
`response..productId`	productId Refers to a (bundled) product on the Entitlement.	Tekenreeks	Ja	-
`response..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..school`	school	Object	Nee	SchoolReference
`response..school.organisationMasterIdentifier`	organisationMasterIdentifier The primary identifier for a School. For Schools the `OnderwijsaanbiederId` is used. (either organisationMasterIdentifier or organisationIds is required)	Tekenreeks	Nee	-
`response..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..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..school.organisationIds[*].organisationId`	organisationId	Tekenreeks	Ja	-
`response..school.organisationIds[*].organisationIdType`	organisationIdType	Keuzelijst	Ja	toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID"]
`response..user`	user	Object	Ja	UserReference
`response..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..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..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..user.userIds[*].userId`	userId	Tekenreeks	Ja	-
`response..user.userIds[*].userIdType`	userIdType	Keuzelijst	Ja	toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"]
`response..activationCode`	activationCode In case the Product has been activated by an activation code, the `Licentieregistratie` reports here that the activation code is being issued.	Tekenreeks	Nee	-
`response..usageDate`	usageDate The date the Product has been activated. Format: YYYY-MM-DD (according to RFC3339).	Datum	Ja	-
`response..usageType`	usageType Within the InitialActivation message this value is always initial-activation	Keuzelijst	Ja	toegestaan ["school-student","school-employee","school-activationcode","customer-student","customer-activationcode"]
`response..expirationDate`	expirationDate The expiration date until this Student or Employee has the right to use the Product. Format: YYYY-MM-DD (according to RFC3339). In case the Entitlement specified a minExpirationDate, the expirationDate equals this minExpirationDate or lies further in the future. The expirationDate allows the `Licentieregistratie` to have license periods for each individual License on an Entitlement.	Datum	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
`202`	Accepted	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.

  /usage/activation:
    put:
      summary: Accept InitialActivation from Licentieregistratie
      operationId: accept-initial-activation
      tags:
        - Aanspraakmanager
      x-tags:
        - InitialActivation
      description: |
        Send an InitialActivation message to the `Aanspraakmanager` after a Student or Employee activated a Product.
        
        The `Aanspraakmanager` is the providers of this endpoint.
        The `Licentieregistratie` should give a 405 HTTP status as result when called.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitialActivation'
      responses:
        '202':
          description: Accepted
        '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 - Aanspraakmanager is provider of this endpoint
      security:
        - OAuth2:
            - eduv.usage.entitlor