GET api/{version}/Ebook/GetCompanionBookDetails?studentProductId={studentProductId}
Get the Companinon Book Details
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| studentProductId | integer |
Required |
|
| version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
StudentEBook| Name | Description | Type | Additional information |
|---|---|---|---|
| StudentEbookTrackId |
Get or set StudentEbookTrackId |
integer |
None. |
| StudentProductElementId |
Get or set StudentProductElementId |
integer |
None. |
| StudentId |
Get or set StudentId |
integer |
None. |
| EBookId |
Get or set EBookId |
integer |
None. |
| LastSeenPageNo |
Get or set LastSeenPageNo |
integer |
None. |
| Annotations |
Get or set Annotations |
string |
None. |
| BookPath |
Get or set BookPath |
string |
None. |
| LicenseKey |
Get or set LicenseKey |
string |
None. |
| HasAccess |
Get or set HasAccess |
boolean |
None. |
| AccessDurations |
Get or set AccessDurations |
string |
None. |
| Title |
Get or set Title |
string |
None. |
| ShowMaintenanceMessage |
Get or set ShowMaintenanceMessage |
boolean |
None. |
| IsAllowDownload |
Get or set IsAllowDownload |
boolean |
None. |
| ElementId |
Get or set ElementId |
integer |
None. |
| OfflineUpdatedOn | date |
None. |
|
| CreatedOn | date |
None. |
|
| LastUpdatedOn | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"StudentEbookTrackId": 1,
"StudentProductElementId": 1,
"StudentId": 1,
"EBookId": 1,
"LastSeenPageNo": 1,
"Annotations": "sample string 1",
"BookPath": "sample string 2",
"LicenseKey": "sample string 3",
"HasAccess": true,
"AccessDurations": "sample string 5",
"Title": "sample string 6",
"ShowMaintenanceMessage": true,
"IsAllowDownload": true,
"ElementId": 9,
"OfflineUpdatedOn": "2026-04-02T23:49:45.042036-04:00",
"CreatedOn": "2026-04-02T23:49:45.042036-04:00",
"LastUpdatedOn": "2026-04-02T23:49:45.042036-04:00"
}