Difference between revisions of "API Collections Create"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→Required Paramaters) |
Tommy.leung (Talk | contribs) (→Required Paramaters) |
||
| Line 24: | Line 24: | ||
| | | | ||
| 255 | | 255 | ||
| − | | | + | | string (length > 0) |
| Name of the collection. | | Name of the collection. | ||
|} | |} | ||
Revision as of 15:24, 4 June 2012
Contents
Summary
Allows for creating a new collection.
URI
https://api.unroole.com/channels/[channel-id]/collections
HTTP Method
POST
Required Paramaters
| Paramater | Default | Maximum Length | Accepted Values | Description |
|---|---|---|---|---|
| token | API Persistence Token that identifies this user and its permissions. | |||
| name | 255 | string (length > 0) | Name of the collection. |
Optional Paramaters
| Paramater | Default | Maximum Length | Accepted Values | |
|---|---|---|---|---|
| description | MySQL TEXT UTF-8 | The description of the collection. | ||
| active | false | boolean | Make the playlist active or deactivate (dis-regardless of the active/deactivate date). | |
| activate_at | ISO 8061 date | This is required if collection is set to active | ||
| deactivate_at | ISO 8061 date | This is required if collection is set to active and does not disable deactivation | ||
| disable_deactivation | boolean | Disable the deactivation date so that the collection will never expire. | ||
| playlist | false | boolean | Whether the collection is a slideshow | |
| rotation_speed | 0 - 900 | The time between the items in the collection playing as a slideshow (in seconds). Only valid when collection is set to a playlist. |
Response
| Field | Type | Description |
|---|---|---|
| http_status | integer | API Status Code http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html |
| error | Rails default | |
| id | integer | The id of the collection if created successfully. |
