API Collections List

From unroole CMS wiki
Revision as of 18:00, 28 November 2013 by Mbasset (Talk | contribs)

Jump to: navigation, search

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 50 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

Search for 'test' returning all fields

Parameters Values
token 1f0qpLwoV5oIcfnU2yvO
search test
fields id,name,description,activate_at,deactivate_at,active,disable_deactivation,slideshow,rotation_speed,updated_at,created_at,items

Limit to first 2 collections

result_length is 3 because there are 3 collections that can be returned, but the user requested only for 2

Parameters Values
token 1f0qpLwoV5oIcfnU2yvO
limit 2
fields id,name