API List Templates

This API call will return a list of all templates for the VALT instance.

Resource URL

http://valt.example.com/api/v3/admin/templates

Resource Information

Method	GET
Response Type	JSON
Authentication Required	Yes

Parameters

No parameters can be passed to this call.

Response

Code	Reason
200	Request Successful
401	Unauthorized

JSON Response

data
			This API returns an array of JSON objects
	id		Template ID Number
	name		Template Name
	type		Template Type (Information, Marker, Evaluation or Email)
	hidden		True = Template is hidden from view, False = Template is visible in web gui.
	entity name		Default Field Name (Recording Name)
		title	Field name, if renamed.
		value	Default value, if specified.
		type	Type of Field (Text or Drop Down)

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/admin/templates?access_token=exampletoken

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":[
{
"id": 1,
"name": "Basic Information",
"type": "info",
"hidden": false,
"entity_name":{
"title": "",
"value": "",
"type": "Text"
}
},
{
"id": 2,
"name": "Basic Marker",
"type": "marker",
"hidden": false,
"entity_name":{"title": "", "value": "", "type": "Text"}
},
{
"id": 3,
"name": "Law Enforcement Info",
"type": "info",
"hidden": false,
"entity_name":{"title": "", "value": "", "type": "Text"},
"fields":[{"id": 1, "on": true, "required": true, "type": "text",…]
},
{
"id": 4,
"name": "Law Enforcement Marker",
"type": "marker",
"hidden": false,
"entity_name":{"title": "", "value": "", "type": "Text"},
"fields":[{"id": 9, "on": true, "required": true, "type": "text",…]
},
{
"id": 5,
"name": "Speech Info",
"type": "info",
"hidden": false,
"entity_name":{"title": "", "value": "", "type": "Text"},
"fields":[{"id": 11, "on": true, "required": true, "type": "text",…]
}
]
}

Failure Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"error":{
"code": 401,
"message": "No API key provided"
}
}