Difference between revisions of "API Collections Update"
From unroole CMS wiki
Tommy.leung (Talk | contribs) |
Tommy.leung (Talk | contribs) |
||
(3 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
+ | <div style="color:red;font-weight:bold;font-size:20px">DRAFT</div><br\> | ||
+ | |||
== Summary == | == Summary == | ||
Line 4: | Line 6: | ||
== URI == | == URI == | ||
− | {{:API_Base_URI}} | + | {{:API_Base_URI}}collections/[collection-id] |
== HTTP Method == | == HTTP Method == | ||
Line 20: | Line 22: | ||
! Description | ! Description | ||
{{:API Required Parameter Common}} | {{:API Required Parameter Common}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Line 36: | Line 32: | ||
! Maximum Length | ! Maximum Length | ||
! Accepted Values | ! Accepted Values | ||
+ | |- | ||
+ | | name | ||
+ | | | ||
+ | | 255 | ||
+ | | string (length > 0) | ||
+ | | Name of the collection. | ||
{{:API_Collections_Create_Update_Parameter}} | {{:API_Collections_Create_Update_Parameter}} | ||
|} | |} |
Latest revision as of 14:18, 4 October 2012
DRAFT
<br\>
Contents
Summary
Allows for updating metadata for a collection.
URI
https://api.unroole.com/collections/[collection-id]
HTTP Method
PUT
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 | |
---|---|---|---|---|
name | 255 | string (length > 0) | Name of the collection. | |
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 |