getRundowns

Description

Example request

https://www.rundowncreator.com/channel4news/API.php
     ?APIKey=edharken
     &APIToken=HNe2ADG0nBTiC8Q8WiVfsxeG5ip51A
     &Action=getRundowns

Example response

[
    {
        "RundownID": 1,
        "Title": "Morning News Update",
        "FolderID": 1,
        "DefaultLayoutID": -1,
        "Start": 1332604500,
        "End": 1332604620,
        "TotalRunningTime": 105,
        "OnAirTimer_Active": 0,
        "OnAirTimer_RowID": -1,
        "OnAirTimer_Date": -1,
        "Frozen": 0,
        "Locked": 0,
        "Archived": 0,
        "Template": 0,
        "Deleted": 0
    },
    {
        "RundownID": 2,
        "Title": "Sports Sunday with Champ Kind",
        "FolderID": 2,
        "DefaultLayoutID": 2,
        "Start": 1332742800,
        "End": 1332743700,
        "TotalRunningTime": 0,
        "OnAirTimer_Active": 1,
        "OnAirTimer_RowID": 52,
        "OnAirTimer_Date": 1332742830,
        "Frozen": 0,
        "Locked": 0,
        "Archived": 0,
        "Template": 0,
        "Deleted": 0
    }
]

Required parameters

Optional parameters

RundownID	integer	if set, only the rundown with the RundownID specified will be returned
Title	string	if set, only rundowns with the Title specified will be returned
Frozen	boolean	if set to true, only rundowns with page numbers that are frozen will be returned. If set to false, only rundowns with page numbers that aren't frozen will be returned. If not set, both rundowns with page numbers that are and aren't frozen will be returned
Locked	boolean	if set to true, only locked rundowns will be returned. If set to false, only unlocked rundowns will be returned. If not set, both locked and unlocked rundowns will be returned
Archived	boolean	if set to true, only archived rundowns will be returned. If set to false, only active rundowns will be returned. If not set, both archived and active rundowns will be returned
Template	boolean	if set to true, only rundown templates will be returned. If set to false, only rundowns will be returned. If not set, both rundown templates and rundowns will be returned
GetDeletedRundowns	boolean	if set to true, rundowns in the trash will be returned. If set to false, they will not. Defaults to false
GetTimestamps	boolean	if set to true, the dates/times that the rundown was created and last modified will be included in the response returned in the DateCreated and DateModified fields. If set to false, they will not. Defaults to false
OrderBy	string	if set, the results in the response returned will be ordered by the field specified. Possible values include RundownID, Title, FolderID, Start and End. Defaults to RundownID
Descending	boolean	if set to true, the results in the response returned will be sorted in descending order. Defaults to false

Returns

RundownID	integer	the rundown's unique ID
DateCreated	integer	the date/time that the rundown was created. Only returned if GetTimestamps is set to true
DateModified	integer	the date/time that the rundown was last modified. Only returned if GetTimestamps is set to true
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
TotalRunningTime	integer	the total amount of time, in seconds, allocated to all of the rows in the rundown (excluding those that have been floated or deleted) using the Est. Duration column
OnAirTimer_Active	boolean	true if the on-air timer is active, false if it is not
OnAirTimer_RowID	integer	the RowID of the row the on-air timer is currently on. -1 if the on-air timer is not active
OnAirTimer_Date	integer	the date/time the on-air timer was started for the row it is currently on. -1 if the on-air timer is not active
Frozen	boolean	true if page numbers are frozen, false if they're not
Locked	boolean	true if the rundown order is locked, false if it is not
Archived	boolean	true if the rundown has been archived, false if it has not
Template	boolean	true if the rundown is a template, false if it is not
Deleted	boolean	true if the rundown is in the trash, false if it is not