Description
Searches scripts for keywords
Example request
https://www.rundowncreator.com/channel4news/API.php
?APIKey=edharken
&APIToken=HNe2ADG0nBTiC8Q8WiVfsxeG5ip51A
&Action=search
&Keywords=La Jolla
&Scope=All
Example response
[
{
"Folder": {
"FolderID": 1,
"Name": "Channel 4 News"
},
"Rundown": {
"RundownID": 1,
"Title": "Morning News Update",
"Start": 1332637200
},
"Row": {
"RowID": 3,
"PageNumber": "A2",
"StorySlug": "MAN ATTACKED BY DOGS"
}
}
]
Required parameters
Keywords |
string |
the keywords to search for |
Scope |
string |
the scope of the search. Possible values include All (for all rundowns, active and archived) or a RundownID (for a specific rundown) |
Optional parameters
OrderBy |
string |
if set, the results in the response returned will be ordered by the field specified. Possible values include Relevance and Date. Defaults to Relevance |
Descending |
boolean |
if set to true, the results in the response returned will be sorted in descending order. Defaults to false |
Returns
Folder.FolderID |
integer |
the unique ID of the folder the search result came from |
Folder.Name |
string |
the name of the folder the search result came from |
Rundown.RundownID |
integer |
the unique ID of the rundown the search result came from |
Rundown.Title |
string |
the title of the rundown the search result came from |
Rundown.Start |
integer |
the start date/time of the rundown the search result came from |
Row.RowID |
integer |
the unique ID of the row the search result came from |
Row.PageNumber |
string |
the story slug of the row the search result came from |