GET v4/assets/:vbid/ancillaries - Read

 

Use this API to list all ancillaries attached to an asset (VBID) stored within VitalSource Manage.

Verb/URI

GET https://api.vitalsource.com/v4/assets/:vbid/ancillaries

Data Definitions

Name
Usage
Description
Data Type
Example
Required
  URL param Request information on ancillary N/A

v4/assets/:vbid/ancillaries

Yes 

 

Request Headers

X-VitalSource-API-Key: ABCDEFGHIJKLMNOP
Content-Type: application/json

Response

Response Body

{
"ancillaries": [
{
"isbn": "VBID_HERE",
"id": NUMBERS,
"type": "DownloadableFile",
"active": true,
"title": "Test File 01",
"url": "https://storage.googleapis.com/vst-manage-ancillaries-prod/VBID_HERE/Test File 01",
"file_size": NUMBERS,
"file_name": "something_01.pptx",
"platform": "mac/windows",
"display_order": 1,
"callback_url": null,
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-07-01T00:00:00Z"
},
{
"isbn": "VBID_HERE",
"id": NUMBERS,
"type": "DownloadableFile",
"active": true,
"title": "Test File 02",
"url": "https://storage.googleapis.com/vst-manage-ancillaries-prod/VBID_HERE/Test File 02",
"file_size": NUMBERS,
"file_name": "something-02.pptx",
"platform": "mac/windows",
"display_order": 2,
"callback_url": null,
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-07-01T00:00:00Z"
},
],
"total_items": 2
}

Response descriptions

Name
Description
isbn The VBID of the associated asset
id ID of the ancillary. This will be returned in payload of POST 
type File = DownloadableFile, URL = CompanionURL
active True/False. 
title Title of the file (DownloadableFile)

url

Ancillary url (CompanionUrl)
file_size The size of the file
file_name  Name of the file
platform What platform this file works on (DownloadableFile)
display_order Order that the ancillary is displayed to the user (CompanionUrl | DownloadableFile)
callback_url Url that should be called once the processing of the file is complete (success or failure). If this is not provided, then the callback url of the parent asset will be used. Note that the callback url is not persisted and will only override the parent asset callback url for this request. This field is only available on the PUT request as that is where the file is actually uploaded.
created_at The date the ancillary was created
updated_at The date the ancillary was last updated

 

Error Codes

HTTP & Error messages 
Message
Notes
200

Ok

 
404

Not found

Verify POST create/update and VBID
422

Unprocessable Entity

Re-verify your request
500

Server Error

 
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.

Articles in this section