getFolders


Description

Gets a list of rundown folders

Example request

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

Example response

[
    {
        "FolderID": 1,
        "Name": "Channel 4 News"
    },
    {
        "FolderID": 2,
        "Name": "Sports"
    }
]

Required parameters

None

Optional parameters

FolderID integer if set, only the folder with the FolderID specified will be returned
Name string if set, only the folder with the Name specified will be returned
GetTimestamps boolean if set to true, the dates/times that the folder 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 FolderID and Name. Defaults to FolderID
Descending boolean if set to true, the results in the response returned will be sorted in descending order. Defaults to false

Returns

FolderID integer the folder's unique ID
DateCreated integer the date/time that the folder was created. Only returned if GetTimestamps is set to true
DateModified integer the date/time that the folder was last modified. Only returned if GetTimestamps is set to true
Name string the folder's name