Difference between revisions of "API Collections List"
Tommy.leung (Talk | contribs) (→URI) |
Tommy.leung (Talk | contribs) |
||
Line 67: | Line 67: | ||
| integer | | integer | ||
| Total number of results that '''could''' be returned. This may not be the number of collections in the response, as it is truncated by ''limit'' parameter. | | Total number of results that '''could''' be returned. This may not be the number of collections in the response, as it is truncated by ''limit'' parameter. | ||
+ | |} | ||
+ | |||
+ | == Examples == | ||
+ | |||
+ | === All collections on the channel === | ||
+ | |||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Parameters | ||
+ | ! Values | ||
+ | |- | ||
+ | | token | ||
+ | | 1f0qpLwoV5oIcfnU2yvO | ||
+ | |} | ||
+ | |||
+ | {| class="wikitable collapsible collapsed" | ||
+ | |- | ||
+ | ! JSON | ||
+ | |- | ||
+ | | <nowiki>http://api.unroole.com/channels/1/collections.json?token=1f0qpLwoV5oIcfnU2yvO</nowiki> | ||
+ | |- | ||
+ | | <blockquote> | ||
+ | <nowiki> | ||
+ | { "collection" : [ { "id" : 1, | ||
+ | "items" : [ { "editable" : true, | ||
+ | "id" : 2, | ||
+ | "item_id" : 302, | ||
+ | "printable" : true, | ||
+ | "shareable" : false, | ||
+ | "type" : "Pdf" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 5, | ||
+ | "item_id" : 299, | ||
+ | "printable" : false, | ||
+ | "shareable" : false, | ||
+ | "type" : "Document" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 7, | ||
+ | "item_id" : 107, | ||
+ | "printable" : false, | ||
+ | "shareable" : false, | ||
+ | "type" : "Video" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 3, | ||
+ | "item_id" : 301, | ||
+ | "printable" : false, | ||
+ | "shareable" : true, | ||
+ | "type" : "Document" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 4, | ||
+ | "item_id" : 300, | ||
+ | "printable" : true, | ||
+ | "shareable" : false, | ||
+ | "type" : "Pdf" | ||
+ | }, | ||
+ | { "editable" : true, | ||
+ | "id" : 1, | ||
+ | "item_id" : 303, | ||
+ | "printable" : true, | ||
+ | "shareable" : true, | ||
+ | "type" : "Image" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 6, | ||
+ | "item_id" : 108, | ||
+ | "printable" : false, | ||
+ | "shareable" : false, | ||
+ | "type" : "Video" | ||
+ | } | ||
+ | ], | ||
+ | "name" : "test collection" | ||
+ | }, | ||
+ | { "id" : 2, | ||
+ | "items" : [ { "editable" : false, | ||
+ | "id" : 15, | ||
+ | "item_id" : 2, | ||
+ | "printable" : false, | ||
+ | "shareable" : false, | ||
+ | "type" : "Image" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 8, | ||
+ | "item_id" : 1, | ||
+ | "printable" : false, | ||
+ | "shareable" : false, | ||
+ | "type" : "Image" | ||
+ | }, | ||
+ | { "editable" : true, | ||
+ | "id" : 10, | ||
+ | "item_id" : 103, | ||
+ | "printable" : false, | ||
+ | "shareable" : true, | ||
+ | "type" : "Image" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 11, | ||
+ | "item_id" : 6, | ||
+ | "printable" : false, | ||
+ | "shareable" : false, | ||
+ | "type" : "Image" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 14, | ||
+ | "item_id" : 3, | ||
+ | "printable" : false, | ||
+ | "shareable" : false, | ||
+ | "type" : "Image" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 13, | ||
+ | "item_id" : 4, | ||
+ | "printable" : false, | ||
+ | "shareable" : false, | ||
+ | "type" : "Image" | ||
+ | }, | ||
+ | { "editable" : true, | ||
+ | "id" : 9, | ||
+ | "item_id" : 104, | ||
+ | "printable" : false, | ||
+ | "shareable" : true, | ||
+ | "type" : "Image" | ||
+ | }, | ||
+ | { "editable" : false, | ||
+ | "id" : 12, | ||
+ | "item_id" : 5, | ||
+ | "printable" : false, | ||
+ | "shareable" : false, | ||
+ | "type" : "Image" | ||
+ | } | ||
+ | ], | ||
+ | "name" : "another collection" | ||
+ | }, | ||
+ | { "id" : 4, | ||
+ | "items" : [ ], | ||
+ | "name" : "blank collection" | ||
+ | } | ||
+ | ], | ||
+ | "http_status" : 200, | ||
+ | "result_length" : 3 | ||
+ | } | ||
+ | </nowiki> | ||
+ | </blockquote> | ||
+ | |} | ||
+ | |||
+ | {| class="wikitable collapsible collapsed" | ||
+ | |- | ||
+ | ! XML | ||
+ | |- | ||
+ | | <nowiki>http://api.unroole.com/channels/1/collections.xml?token=1f0qpLwoV5oIcfnU2yvO</nowiki> | ||
+ | |- | ||
+ | | <blockquote> | ||
+ | <nowiki> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <hash> | ||
+ | <collection type="array"> | ||
+ | <collection> | ||
+ | <id type="integer">1</id> | ||
+ | <name>test collection</name> | ||
+ | <items type="array"> | ||
+ | <item> | ||
+ | <id type="integer">2</id> | ||
+ | <item-id type="integer">302</item-id> | ||
+ | <type>Pdf</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">true</editable> | ||
+ | <printable type="boolean">true</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">5</id> | ||
+ | <item-id type="integer">299</item-id> | ||
+ | <type>Document</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">7</id> | ||
+ | <item-id type="integer">107</item-id> | ||
+ | <type>Video</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">3</id> | ||
+ | <item-id type="integer">301</item-id> | ||
+ | <type>Document</type> | ||
+ | <shareable type="boolean">true</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">4</id> | ||
+ | <item-id type="integer">300</item-id> | ||
+ | <type>Pdf</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">true</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">1</id> | ||
+ | <item-id type="integer">303</item-id> | ||
+ | <type>Image</type> | ||
+ | <shareable type="boolean">true</shareable> | ||
+ | <editable type="boolean">true</editable> | ||
+ | <printable type="boolean">true</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">6</id> | ||
+ | <item-id type="integer">108</item-id> | ||
+ | <type>Video</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | </items> | ||
+ | </collection> | ||
+ | <collection> | ||
+ | <id type="integer">2</id> | ||
+ | <name>another collection</name> | ||
+ | <items type="array"> | ||
+ | <item> | ||
+ | <id type="integer">15</id> | ||
+ | <item-id type="integer">2</item-id> | ||
+ | <type>Image</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">8</id> | ||
+ | <item-id type="integer">1</item-id> | ||
+ | <type>Image</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">10</id> | ||
+ | <item-id type="integer">103</item-id> | ||
+ | <type>Image</type> | ||
+ | <shareable type="boolean">true</shareable> | ||
+ | <editable type="boolean">true</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">11</id> | ||
+ | <item-id type="integer">6</item-id> | ||
+ | <type>Image</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">14</id> | ||
+ | <item-id type="integer">3</item-id> | ||
+ | <type>Image</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">13</id> | ||
+ | <item-id type="integer">4</item-id> | ||
+ | <type>Image</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">9</id> | ||
+ | <item-id type="integer">104</item-id> | ||
+ | <type>Image</type> | ||
+ | <shareable type="boolean">true</shareable> | ||
+ | <editable type="boolean">true</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | <item> | ||
+ | <id type="integer">12</id> | ||
+ | <item-id type="integer">5</item-id> | ||
+ | <type>Image</type> | ||
+ | <shareable type="boolean">false</shareable> | ||
+ | <editable type="boolean">false</editable> | ||
+ | <printable type="boolean">false</printable> | ||
+ | </item> | ||
+ | </items> | ||
+ | </collection> | ||
+ | <collection> | ||
+ | <id type="integer">4</id> | ||
+ | <name>blank collection</name> | ||
+ | <items type="array"/> | ||
+ | </collection></collection> | ||
+ | <result-length type="integer">3</result-length> | ||
+ | <http-status type="integer">200</http-status> | ||
+ | </hash> | ||
+ | </nowiki> | ||
+ | </blockquote> | ||
|} | |} |
Revision as of 10:17, 26 June 2012
Contents
Summary
Allows querying for a list of collections in the channel. The query is a wildcard search on:
- name
- description
URI
https://api.unroole.com/channels/[channel-id]/collections
HTTP Method
GET
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 |
---|---|---|---|---|
search | string | The search terms to be used in the query. | ||
limit | TBD | The maximum number of collections to return. | ||
fields | id, name, items | API Collection Fields | List of comma separated fields to be returned in the response. |
Response
Field | Type | Description |
---|---|---|
http_status | integer | API Status Code http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html |
error | Rails default | |
collections | array of API Collection Fields | List of collections |
result_length | integer | Total number of results that could be returned. This may not be the number of collections in the response, as it is truncated by limit parameter. |
Examples
All collections on the channel
Parameters | Values |
---|---|
token | 1f0qpLwoV5oIcfnU2yvO |
JSON |
---|
http://api.unroole.com/channels/1/collections.json?token=1f0qpLwoV5oIcfnU2yvO |
|
XML |
---|
http://api.unroole.com/channels/1/collections.xml?token=1f0qpLwoV5oIcfnU2yvO |
|