Proxy
| API | Description |
|---|---|
| POST api/Proxy/SendUserProfileLicenseReportsUpdatedMessage |
Sends SendUserProfileLicenseReportsUpdatedMessage |
UserInteraction
| API | Description |
|---|---|
| POST api/UserInteraction |
Log new user interaction. |
| POST api/CreateUserAuthorizationActivity |
Creates user authorization activity |
| POST api/UserCheckLicenseEvent |
Sends UserCheckLicenseEventPublicationMessage |
Synchronization
Provides ability to synchronize licensed institutions data with third party
| API | Description |
|---|---|
| GET api/sync/institutions?productIsbn={productIsbn} |
Searches for all institutions which have a valid license and are related to the specific product |
License
| API | Description |
|---|---|
| GET api/GetLicense?userId={userId}&productKey={productKey}&institutionNumber={institutionNumber}&parentProductKey={parentProductKey}&classLevel={classLevel} |
Gets information about user licence for specific product (profile scope required) |
| GET api/GetLicenseAnonymized?userId={userId}&productKey={productKey}&institutionNumber={institutionNumber}&parentProductKey={parentProductKey}&classLevel={classLevel} |
Gets anonymized information about user licence for specific product |
| GET api/License?userId={userId}&productKey={productKey}&institutionNumber={institutionNumber} |
Gets information about user licence for specific product (profile scope required) |
User
| API | Description |
|---|---|
| GET api/User?userId={userId}&contextIdentifier={contextIdentifier} |
Gets information about user in context of specific identifier (profile scope required) |
| GET api/User?userId={userId} |
Gets information about user (profile scope required) |
| GET api/UserAnonymized?userId={userId}&contextIdentifier={contextIdentifier} |
Gets base anonymized information about user in context of specific identifier |
| POST api/GetUsersInInstitution |
Gets information about users assigned to given institution (profile scope required) |
| POST api/GetUsersInUserGroup |
Gets information about users assigned to user group (profile scope required) |
| GET api/user/userFullName?userFullName={userFullName} |
Returns a userID based on the provided user's full name. (profile scope required) |
| GET api/user/username?userName={userName} |
Returns a userID based on the provided username. |
| GET api/user/institutions?userId={userId} |
No documentation available. |
Owners
| API | Description |
|---|---|
| POST api/owners |
Returns all owners in specific account context based on provided filters (profile scope required) |
Heartbeat
| API | Description |
|---|---|
| GET api/heartbeat |
Returns OK if service is running |
| POST api/heartbeat |
Returns OK if service is running |
UserGroup
| API | Description |
|---|---|
| POST api/GetUserGroups |
Returns courses and classes for given institutionNumber |
| POST api/GetUserGroupsInUserGroup |
Return child user groups to user group |
| GET api/UserGroup/{id} |
Returns specific UserGroup based on id |
Products
Provides ability to retrieve information about licensed products
| API | Description |
|---|---|
| GET api/products/getForInstitution?institutionNumber={institutionNumber}&isbn={isbn}&includeLicenses={includeLicenses} |
Retrieves licensed products for institution |
| GET api/products/getForUser?userId={userId}&institutionNumber={institutionNumber}&isbn={isbn}&includeLicenses={includeLicenses} |
Retrieves licensed products for user |
| GET api/products/getShowcase?includeLicenses={includeLicenses} |
Retrieves showcase products |