AssetRss
Returns asset/list of assets in xml for rss feed
URL Format
/ws/asset_rss/api/{app_token}/mode/json/apiv/5?a={assetid}&r={referenceId}&date_start={date_start}&date_end={date_end}&start={start}&end={end}&title={title}&sortby={sortby}&sortdir={sortdir}&assetType={assetType}&folder={folderid}&tags={tags}
Parameters
Name |
Req |
Type |
Description |
app_token |
|
string |
The api token for the given account. You can find the api token when navigating through account->api accounts |
apiv |
|
integer |
The api version; only version 5 supported. |
a |
|
string |
the assetid of a given asset. All the other params are ignored if the assetid is set. |
r |
|
string |
referenceId of a given asset. All the other params are ignored if the referenceId is set. |
date_start |
|
string |
start date filter for getting asset list for a given account .Date must be in t/z format. Example 2013-05-07T06:17:55.827Z. All dates must be in UTC. |
date_end |
|
string |
end date filter for getting asset list for a given account. Date must be in t/z format. Example 2013-05-07T06:17:55.827Z. All dates must be in UTC. |
title |
|
string |
filter the response based on asset title. Use '%' to do partial matches for asset title. Example "%asset title%". Needs to be url encoded. Example %mytitle% after urlencoded becomes %mytitle%25. |
sortby |
|
string |
The column to sort by. Can be {title, date_start, date_end, datemod, dateadd, filesize} |
sortdir |
|
string |
The sort direction. Can be {asc, desc} |
start |
|
int |
Will return a subset of available assets. Used primarily for pagination. Default is set to 0 |
end |
|
integer |
Will return a subset of available assets. Used primarily for pagination. Default is set to start+20 Zero-based exclusive index: E.G. &start=0&send=4 will return 4 programs from the beginning. |
assetType |
|
string |
filter for getting asset types. Possible values {audio, video, image, binary, presentation, all} |
folder |
|
int |
filter for folder id for a given account |
tags |
|
string |
Filter for tags of an asset. Use '%' to do partial matches for asset tags. Example "%asset tag%". Needs to be url encoded. Example %mytag% after urlencoded becomes %mytag%25. |
Request Headers
Possible Responses
- 303 Invalid Asset ID
- 1036 Invalid reference Id
- 659 Invalid Client
- 1038 Invalid date_start
- 1039 Invalid date_end
- 205 invalid asset type
- 1051 Invalid Boolean Params
- 1041 Invalid sort params
- 912 Invalid sort direction params
- 913 Invalid limit params
Example Response
null