Difference between revisions of "API Collection Add Asset"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→URI) |
Tommy.leung (Talk | contribs) (→URI) |
||
| Line 4: | Line 4: | ||
== URI == | == URI == | ||
| − | {{:API_Base_URI}} | + | {{:API_Base_URI}}sorted_playlists/[playlist-id]/add_items |
== HTTP Method == | == HTTP Method == | ||
Revision as of 12:33, 4 June 2012
Contents
Summary
Allows for adding an asset to the collection.
URI
https://api.unroole.com/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 |
|---|---|---|
| http_status | integer | API Status Code http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html |
| error | Rails default | |
| 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 |
