getColumns
Description
Gets a list of user-customizable rundown columns
Example request
https://www.rundowncreator.com/channel4news/API.php ?APIKey=edharken &APIToken=HNe2ADG0nBTiC8Q8WiVfsxeG5ip51A &Action=getColumns
Example response
[ { "ColumnID": 1, "Name": "Writer" }, { "ColumnID": 2, "Name": "Editor" }, { "ColumnID": 3, "Name": "Segment" }, { "ColumnID": 4, "Name": "Talent" }, { "ColumnID": 5, "Name": "Camera" }, { "ColumnID": 6, "Name": "Effect" }, { "ColumnID": 7, "Name": "Graphic" }, { "ColumnID": 8, "Name": "Source" }, { "ColumnID": 9, "Name": "VTR" }, { "ColumnID": 10, "Name": "File" } ]
Required parameters
None
Optional parameters
ColumnID | integer | if set, only the column with the ColumnID specified will be returned |
Name | string | if set, only the column with the Name specified will be returned |
GetTimestamps | boolean | if set to true, the dates/times that the column 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 ColumnID and Name. Defaults to ColumnID |
Descending | boolean | if set to true, the results in the response returned will be sorted in descending order. Defaults to false |
Returns
ColumnID | integer | the column's unique ID |
DateCreated | integer | the date/time that the column was created. Only returned if GetTimestamps is set to true |
DateModified | integer | the date/time that the column was last modified. Only returned if GetTimestamps is set to true |
Name | string | the column's name |