API Templates

This API call will return the default information and marker templates for the VALT instance. This is typically the first information and marker template created. This will be the information and marker template utilized for any new groups if one is not specified upon creation.

Resource URL

http://valt.example.com/api/v3/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
info_template			Default information template
	id		Information Template ID Number
	name		Information Template Name
	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)
marker_template			Default marker template
	id		Marker Template ID Number
	name		Marker Template Name
	entity name		Default Field Name (Marker 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/templates?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

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

{
"data":{
"info_template":{
"id": 1,
"name": "Basic Information",
"entity_name":{
"title": "",
"value": "",
"type": "Text"
}
},
"marker_template":{
"id": 2,
"name": "Basic Marker",
"entity_name":{
"title": "",
"value": "",
"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"
}
}