Description
Gets a list of script templates
Example request
https://www.rundowncreator.com/channel4news/API.php
?APIKey=edharken
&APIToken=HNe2ADG0nBTiC8Q8WiVfsxeG5ip51A
&Action=getScriptTemplates
Example response
[
{
"ScriptTemplateID": 1,
"Name": "VO",
"Content": "{ANCHOR}\r\n\r\n{VO}"
},
{
"ScriptTemplateID": 2,
"Name": "VOSOT",
"Content": "{ANCHOR}\r\n\r\n{VO}\r\n\r\n{SOT}\r\n(\"\")\r\n[Outcue: 0 \"\"]\r\n\r\n{MORE VO}"
},
{
"ScriptTemplateID": 3,
"Name": "Reader",
"Content": "{ANCHOR}"
},
{
"ScriptTemplateID": 4,
"Name": "1 Line",
"Content": "<cg id=\"\" template=\"1line\" line1=\"\">"
},
{
"ScriptTemplateID": 5,
"Name": "2 Line",
"Content": "<cg id=\"\" template=\"2line\" line1=\"\" line2=\"\">"
},
{
"ScriptTemplateID": 6,
"Name": "Graphic",
"Content": "<graphic id=\"\" filename=\"\">"
},
{
"ScriptTemplateID": 7,
"Name": "Audio Clip",
"Content": "<audio id=\"\" filename=\"\" duration=\"0\">"
},
{
"ScriptTemplateID": 8,
"Name": "Video Clip",
"Content": "<video id=\"\" filename=\"\" duration=\"0\">"
}
]
Required parameters
None
Optional parameters
ScriptTemplateID |
integer |
if set, only the script template with the ScriptTemplateID specified will be returned |
Name |
string |
if set, only script templates with the Name specified will be returned |
GetContent |
boolean |
if set to true, the script template's content will be included in the response returned in the Content field. If set to false, it will not. Defaults to true |
GetTimestamps |
boolean |
if set to true, the dates/times that the script template 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 ScriptTemplateID, ScriptTemplateFolderID, and Name. Defaults to ScriptTemplateID |
Descending |
boolean |
if set to true, the results in the response returned will be sorted in descending order. Defaults to false |
Returns
ScriptTemplateID |
integer |
the script template's unique ID |
DateCreated |
integer |
the date/time that the script template was created. Only returned if GetTimestamps is set to true |
DateModified |
integer |
the date/time that the script template was last modified. Only returned if GetTimestamps is set to true |
Name |
string |
the script template's name |
Content |
string |
the script template's content. Only returned if GetContent is true (it is by default) |