Difference between revisions of "API Collections Create Update Parameter"

From unroole CMS wiki
Jump to: navigation, search
 
(5 intermediate revisions by one user not shown)
Line 1: Line 1:
 
|-
 
|-
| unroole_sorted_playlist[description]
+
| description
 
|  
 
|  
| ~17000 characters
+
| MySQL TEXT UTF-8
 
|
 
|
 
| The description of the collection.
 
| The description of the collection.
 
|-
 
|-
| unroole_sorted_playlist[active]
+
| active
|
+
| false
 
|  
 
|  
 
| boolean
 
| boolean
 
| Make the playlist active or deactivate (dis-regardless of the active/deactivate date).
 
| Make the playlist active or deactivate (dis-regardless of the active/deactivate date).
 
|-
 
|-
| unroole_sorted_playlist[activate_at(1i)]
+
| activate_at
 
|  
 
|  
 
|  
 
|  
| integer
+
| [http://www.w3.org/TR/NOTE-datetime ISO 8061 date]
| Activate at year
+
| '''This is required if collection is set to active'''
 
|-
 
|-
| unroole_sorted_playlist[activate_at(2i)]
+
| deactivate_at
|
+
|
+
| integer (1-12)
+
| Activate at month
+
|-
+
| unroole_sorted_playlist[activate_at(3i)]
+
 
|  
 
|  
 
|  
 
|  
| integer (1-31)
+
| [http://www.w3.org/TR/NOTE-datetime ISO 8061 date]
| Activate at day
+
| '''This is required if collection is set to active and does not disable deactivation'''
 
|-
 
|-
| unroole_sorted_playlist[deactivate_at(1i)]
+
| disable_deactivation
|
+
|
+
| integer
+
| Activate at year
+
|-
+
| unroole_sorted_playlist[deactivate_at(2i)]
+
|
+
|
+
| integer (1-12)
+
| Activate at month
+
|-
+
| unroole_sorted_playlist[deactivate_at(3i)]
+
|
+
|
+
| integer (1-31)
+
| Activate at day
+
|-
+
| unroole_sorted_playlist[disable_deactivation]
+
 
|
 
|
 
|
 
|
Line 54: Line 30:
 
| Disable the deactivation date so that the collection will never expire.
 
| Disable the deactivation date so that the collection will never expire.
 
|-
 
|-
| unroole_sorted_playlist[playlist]
+
| playlist
|
+
| false
 
|
 
|
 
| boolean
 
| boolean
 
| Whether the collection is a slideshow
 
| Whether the collection is a slideshow
 
|-
 
|-
| unroole_sorted_playlist[rotation_speed]
+
| rotation_speed
 
|  
 
|  
 
|
 
|
 
| 0 - 900
 
| 0 - 900
| The time between the items in the collection playing as a slideshow (in seconds).
+
| The time between the items in the collection playing as a slideshow (in seconds). '''Only valid when collection is set to a playlist.'''

Latest revision as of 15:23, 4 June 2012

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