Description
Sets one or more properties of a rundown
Example request
https://www.rundowncreator.com/channel4news/API.php
?APIKey=edharken
&APIToken=HNe2ADG0nBTiC8Q8WiVfsxeG5ip51A
&Action=setRundownProperties
&RundownID=3
&Start=1332637260
&End=1332639060
Example response
{
"Success": 1
}
Required parameters
RundownID |
integer |
the unique ID of the rundown to change |
Optional parameters
Title |
string |
the rundown's title |
FolderID |
integer |
the unique ID of the folder the rundown is stored in |
DefaultLayoutID |
integer |
the unique ID of the layout this rundown should be loaded with, or -1 if it should be loaded using the user's default personal layout |
Start |
integer |
the rundown's start date/time |
End |
integer |
the rundown's end date/time |
Frozen |
boolean |
if set to true, the rundown's page numbers will be frozen. If set to false, the rundown's page numbers will be unfrozen |
Locked |
boolean |
if set to true, the rundown's order will be locked. If set to false, it will be unlocked |
Archived |
boolean |
if set to true, the rundown will be archived. If set to false, the rundown will be unarchived |
Template |
boolean |
if set to true, the rundown will be marked as a template. If set to false, it will be marked as a rundown |
Returns
Success |
boolean |
true if successful, false if unsuccessful |
Notes
Requires permissions of a producer or higher.