API Collection Add Asset

Summary

Allows for adding an asset to the collection.

URI

https://api.unroole.com/collections/[collection-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
item_ids[]			Each item must be in the format [page OR asset]_[item-id] e.g. asset_18, page_232, asset_54	Array of item ids 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 ids	List of item_ids that were successfully added to the collection
failed_items	array of ids	List of item_ids that failed to be added to the collection

Examples

these example require jQuery

Add to the collection

This user does not have access to page_2, asset_304, and asset_305

Paramater	Value
token	1f0qpLwoV5oIcfnU2yvO
item_ids[]	['page_2', 'page_3', 'asset_303', 'asset_304', 'asset_305']

jQuery ajax call
$.ajax('http://api.unroole.com/collections/1/add_items?token=1f0qpLwoV5oIcfnU2yvO', { headers: { // use below for json request Accept : "application/json, text/javascript" // use below for xml request //Accept : "text/html,application/xhtml+xml,application/xml" }, type: 'POST', data: { item_ids: ['page_2', 'page_3', 'asset_303', 'asset_304', 'asset_305'] } });

JSON
{"success_items":["page_3","asset_303"],"failed_items":["page_2","asset_304","asset_305"],"http_status":200}

XML

<?xml version="1.0" encoding="UTF-8"?> <hash> <success-items type="array"> <success-item>page_3</success-item> <success-item>asset_303</success-item> </success-items> <failed-items type="array"> <failed-item>page_2</failed-item> <failed-item>asset_304</failed-item> <failed-item>asset_305</failed-item> </failed-items> <http-status type="integer">200</http-status> </hash>tatus type="integer">200</http-status> </hash>