GET api/GetLicense?userId={userId}&productKey={productKey}&institutionNumber={institutionNumber}&parentProductKey={parentProductKey}&classLevel={classLevel}

Gets information about user licence for specific product (profile scope required)

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	User id that is returned in loging process.	globally unique identifier	Required
productKey	Product uniq ISBN number	string	Required
institutionNumber	Optional contextidentifier or institution number as a fallback	string	None.
parentProductKey	Optional parent product key used for reporting purposes	string	None.
classLevel	Optional class level used for reporting purposes	integer	None.

Body Parameters

None.

Response Information

Resource Description

Returns user details in context of account and product

LicenseDetailsResponse

Name	Type	Additional information
UserName	string	None.
FirstName	string	None.
LastName	string	None.
Sex	string	None.
IsValid	boolean	None.
Message	string	None.
InstitutionId	string	None.
InstitutionName	string	None.
LicenseType	integer	None.
AccessType	integer	None.
ClassName	string	None.
GradeLevel	string	None.
UserId	globally unique identifier	None.
UserType	string	None.

Response Formats

application/xml, text/xml

Sample:

<LicenseDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
  <AccessType>10</AccessType>
  <ClassName>sample string 11</ClassName>
  <GradeLevel>sample string 12</GradeLevel>
  <InstitutionId>sample string 7</InstitutionId>
  <InstitutionName>sample string 8</InstitutionName>
  <IsValid>true</IsValid>
  <LicenseType>9</LicenseType>
  <Message>sample string 6</Message>
  <UserId>b505a068-f8b0-49fc-862d-c60bc0107047</UserId>
  <UserType>sample string 14</UserType>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <Sex>sample string 4</Sex>
  <UserName>sample string 1</UserName>
</LicenseDetailsResponse>

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Sex": "sample string 4",
  "IsValid": true,
  "Message": "sample string 6",
  "InstitutionId": "sample string 7",
  "InstitutionName": "sample string 8",
  "LicenseType": 9,
  "AccessType": 10,
  "ClassName": "sample string 11",
  "GradeLevel": "sample string 12",
  "UserId": "b505a068-f8b0-49fc-862d-c60bc0107047",
  "UserType": "sample string 14"
}