Description
Gets a list of rows in a rundown, or a specific row
Example request
https://www.rundowncreator.com/channel4news/API.php
?APIKey=edharken
&APIToken=HNe2ADG0nBTiC8Q8WiVfsxeG5ip51A
&Action=getRows
&RundownID=1
Example response
[
{
"RowID": 2,
"RundownID": 1,
"Position": 10,
"PageNumber": "A1",
"StorySlug": "UPDATE OPEN",
"writer": "",
"editor": "",
"segment": "OPEN",
"talent": "",
"camera": "",
"effect": "TOP",
"graphic": "",
"source": "",
"vtr": "E",
"file": "OPEN",
"Break": 0,
"ScriptHasContent": 1,
"Approved": 0,
"Floated": 0,
"Locked": 0,
"Following": 0,
"EstimatedDuration": 10,
"ActualDuration": 0,
"Deleted": 0
},
{
"RowID": 3,
"RundownID": 1,
"Position": 20,
"PageNumber": "A2",
"StorySlug": "MAN ATTACKED BY DOGS",
"writer": "",
"editor": "",
"segment": "VO",
"talent": "RON",
"camera": "2",
"effect": "",
"graphic": "",
"source": "",
"vtr": "A",
"file": "",
"Break": 0,
"ScriptHasContent": 1,
"Approved": 0,
"Floated": 0,
"Locked": 0,
"Following": 0,
"EstimatedDuration": 35,
"ActualDuration": 33,
"Deleted": 0
},
{
"RowID": 4,
"RundownID": 1,
"Position": 30,
"PageNumber": "A3",
"StorySlug": "MAN ATTACKED BY DOGS",
"writer": "",
"editor": "",
"segment": "SOTVO",
"talent": "RON",
"camera": "",
"effect": "TOP",
"graphic": "",
"source": "",
"vtr": "B",
"file": "",
"Break": 0,
"ScriptHasContent": 0,
"Approved": 0,
"Floated": 0,
"Locked": 0,
"Following": 0,
"EstimatedDuration": 0,
"ActualDuration": 0,
"Deleted": 0
},
{
"RowID": 5,
"RundownID": 1,
"Position": 40,
"PageNumber": "A4",
"StorySlug": "BANK ROBBERY",
"writer": "",
"editor": "",
"segment": "VO",
"talent": "RON",
"camera": "2",
"effect": "",
"graphic": "",
"source": "",
"vtr": "C",
"file": "",
"Break": 0,
"ScriptHasContent": 0,
"Approved": 0,
"Floated": 0,
"Locked": 0,
"Following": 0,
"EstimatedDuration": 20,
"ActualDuration": 0,
"Deleted": 0
},
{
"RowID": 6,
"RundownID": 1,
"Position": 50,
"PageNumber": "A5",
"StorySlug": "PANDA WATCH",
"writer": "",
"editor": "",
"segment": "VO",
"talent": "RON",
"camera": "2",
"effect": "",
"graphic": "",
"source": "",
"vtr": "D",
"file": "",
"Break": 0,
"ScriptHasContent": 0,
"Approved": 0,
"Floated": 0,
"Locked": 0,
"Following": 0,
"EstimatedDuration": 20,
"ActualDuration": 0,
"Deleted": 0
},
{
"RowID": 7,
"RundownID": 1,
"Position": 60,
"PageNumber": "A6",
"StorySlug": "GOODBYE",
"writer": "",
"editor": "",
"segment": "RDR",
"talent": "RON",
"camera": "2",
"effect": "",
"graphic": "",
"source": "",
"vtr": "",
"file": "",
"Break": 0,
"ScriptHasContent": 0,
"Approved": 0,
"Floated": 0,
"Locked": 0,
"Following": 0,
"EstimatedDuration": 10,
"ActualDuration": 0,
"Deleted": 0
},
{
"RowID": 8,
"RundownID": 1,
"Position": 70,
"PageNumber": "A7",
"StorySlug": "UPDATE CLOSE",
"writer": "",
"editor": "",
"segment": "GRFX",
"talent": "WIDE SHOT",
"camera": "3",
"effect": "TOP",
"graphic": "",
"source": "",
"vtr": "F",
"file": "CLOSE",
"Break": 0,
"ScriptHasContent": 1,
"Approved": 0,
"Floated": 0,
"Locked": 0,
"Following": 0,
"EstimatedDuration": 10,
"ActualDuration": 0,
"Deleted": 0
}
]
Required parameters
| RundownID |
integer |
if set, all rows in the rundown with the RundownID specified will be returned |
| -or- |
|
|
| RowID |
integer |
if set, only the row with the RowID specified will be returned |
Optional parameters
| ScriptHasContent |
boolean |
if set to true, only rows with scripts that aren't blank will be returned. If set to false, only rows with scripts that are blank will be returned. If not set, both rows with scripts that are and aren't blank will be returned |
| Floated |
boolean |
if set to true, only rows that have been floated will be returned. If set to false, only rows that haven't been floated will be returned. If not set, both rows that have and haven't been floated will be returned |
| Approved |
boolean |
if set to true, only rows with scripts that have been approved will be returned. If set to false, only rows with scripts that haven't been approved will be returned. If not set, both rows with scripts that have and haven't been approved will be returned |
| Locked |
boolean |
if set to true, only rows with scripts that are locked will be returned. If set to false, only rows with scripts that aren't locked will be returned. If not set, both rows with scripts that are and aren't locked will be returned |
| GetDeletedRows |
boolean |
if set to true, rows in the trash will be returned. If set to false, they won't. Defaults to false |
| GetColumns |
boolean |
if set to true, the response returned will include fields for user-customizable rundown columns like "Segment" and "Graphic". If set to false, it will not. Defaults to true |
| RemapColumns |
boolean |
if set to true, the response returned will use human-friendly field names for user-customizable rundown columns like "Segment" and "Graphic". For example, the field name used for the "Segment" column might be "segment", and the field name used for the "Graphic" column might be "graphic". If set to false, the response returned will use generic field names combining the word "Column" with the column's ColumnID. For example, "Column5" or "Column12". Defaults to true |
| MinifyColumns |
boolean |
if set to true, the response returned will not include fields for user-customizable rundown columns like "Segment" and "Graphic" when they're blank. If set to false, the response returned will always include fields for these columns, even when they're blank. Defaults to false |
| GetScript |
boolean |
if set to true, the row's script will be included in the response returned in the Script field. If set to false, it will not. Defaults to false |
| RemoveCurlyBrackets |
boolean |
if set to true, text in curly brackets will be removed from the script in the Script field. If set to false, it will not. Defaults to false |
| RemoveSquareBrackets |
boolean |
if set to true, text in square brackets will be removed from the script in the Script field. If set to false, it will not. Defaults to false |
| RemoveParentheses |
boolean |
if set to true, text in parentheses will be removed from the script in the Script field. If set to false, it will not. Defaults to false |
| RemoveCarets |
boolean |
if set to true, text in carets will be removed from the script in the Script field. If set to false, it will not. Defaults to false |
| GetObjects |
boolean |
if set to true, an array of objects in the row's script (like CGs, stills, audio clips, and video clips) will be included in the response returned in the Objects field. If set to false, it will not. Defaults to false |
| Type |
string |
if set, only objects of the Type specified will be returned in the Objects field |
| GetRowsWithoutObjects |
boolean |
if set to false, only rows with objects (of the Type specified, if Type is set) in their script will be returned. If set to true, both rows with and without objects in their script will be returned. Defaults to true |
| GetFrontandBackTimes |
boolean |
if set to true, each row's front and back time will be included in the response returned in the FrontTime and BackTime fields. If set to false, they will not. Defaults to false |
| GetBeforeandAfter |
boolean |
if set to true, the RowID of the row before and after the row in the rundown will be included in the response returned in the Before and After fields. If set to false, it will not. Defaults to false |
| GetTimestamps |
boolean |
if set to true, the dates/times that the row 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 |
Returns
| RowID |
integer |
the row's unique ID |
| DateCreated |
integer |
the date/time that the row was created. Only returned if GetTimestamps is set to true |
| DateModified |
integer |
the date/time that the row was last modified. Only returned if GetTimestamps is set to true |
| RundownID |
integer |
the unique ID of the rundown the row is in |
| Position |
integer |
the row's position in the rundown. Starts at 10 and increments by 10 |
| PageNumber |
string |
the row's page number |
| StorySlug |
string |
the row's story slug |
| Column |
string |
if GetColumns is true (it is by default), the response returned will include fields for user-customizable rundown columns like "Segment" and "Graphic" (unless MinifyColumns is set to true and the field is empty). If RemapColumns is true (it is by default too), the field names used will be human-friendly versions of the column names. For example: "segment" for the "Segment" column, and "graphic" for the "Graphic" column. If RemapColumns is false, the field names used will be generic field names combining the word "Column" and the column's ColumnID, like "Column5" and "Column12" |
| Break |
boolean |
true if the row is a break, false if it is not |
| ScriptHasContent |
boolean |
true if the row's script has content in it, false if it does not |
| Approved |
boolean |
true if the row's script has been approved, false if it has not |
| Floated |
boolean |
true if the row has been floated, false if it has not |
| Locked |
boolean |
true if the row's script has been locked, false if it has not |
| Following |
boolean |
true if you're following the script, false if you're not |
| EstimatedDuration |
integer |
the amount of time, in seconds, allocated to the row in the rundown |
| ActualDuration |
integer |
how long, in seconds, the row's script times out to be, based on the number of characters in it (excluding text in curly brackets, square brackets, parentheses, and carets), the ReadRate, and any durations like [30] or [1:45] in the script |
| FrontTime |
integer |
the row's front time. Only returned if GetFrontandBackTimes is set to true |
| BackTime |
integer |
the row's back time. Only returned if GetFrontandBackTimes is set to true |
| Before |
integer |
the RowID of the row before this row in the rundown. 0 if there is none. Only returned if GetBeforeandAfter is set to true |
| After |
integer |
the RowID of the row after this row in the rundown. 0 if there is none. Only returned if GetBeforeandAfter is set to true |
| Objects |
object |
an array of objects (like CGs, stills, audio clips, or video clips) in the row's script. Only returned if GetObjects is set to true |
| Deleted |
boolean |
true if the row is in the trash, false if it's not |
