Difference between revisions of "API Collection Add Asset"

From unroole CMS wiki
Jump to: navigation, search
(Created page with "== Summary == Allows for adding an asset to the collection. == URI == http://[channel_subdomain]-[account_subdomain].unroole.com/unroole/admin/sorted_playlists/[playlist_id...")
 
(URI)
Line 4: Line 4:
  
 
== URI ==
 
== URI ==
 
+
<nowiki>https://api.unroole.com/[channel-id]/sorted_playlists/[playlist-id]/add_items</nowiki>
http://[channel_subdomain]-[account_subdomain].unroole.com/unroole/admin/sorted_playlists/[playlist_id]/add_items
+
 
+
[channel_subdomain] is optional
+
  
 
== HTTP Method ==
 
== HTTP Method ==

Revision as of 09:00, 31 May 2012

Summary

Allows for adding an asset to the collection.

URI

https://api.unroole.com/[channel-id]/sorted_playlists/[playlist-id]/add_items

HTTP Method

POST

Required Paramaters

Paramater Default Maximum Length Accepted Values Description
token API Persistence Token that identifies this user and its permissions.

Optional Paramaters

Paramater Default Maximum Length Accepted Values Description
bulk_change_collection_items_ids[] Each item must be in the format ['page' OR 'asset']_[item_id]
e.g. asset_18, page_232, asset_54
Array of items to add to the collection.

Response

Field Type Description
status string API Status Code
success_items array of items List of items that were successfully added to the collection
failed_items array of items List of items that failed to be added to the collection
error

Example Response