API List Markers

This API provides a list of all current markers on the specified recording. This API call can be used on a recording in progress.

Resource URL

http://valt.example.com/api/v3/records/{recordid}/markers

Replace {recordid} with the actual id number of the record. Records are numbered sequentially when added to VALT.

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
markers			Array of markers. (Will return an empty array if there are no markers in the video.)
	id		Marker ID
	event		Marker Name
	time		Time index in seconds where the marker is located in the video.
	color		Marker Color (Valid Values)
	hex_color		Hex code for the specified color. (Valid Values)
	template		Array of fields and data in the marker template.
		{fieldname}	Field Value

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/records/616/markers?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":{
"markers":[
{
"id": 21,
"event": "Test",
"time": 24,
"color": "red",
"hex_color": "#ff0000",
"template":[
]
},
{
"id": 22,
"event": "Test 2",
"time": 98,
"color": "red",
"hex_color": "#ff0000",
"template":[
]
},
{
"id": 23,
"event": "Test 3",
"time": 157,
"color": "red",
"hex_color": "#ff0000",
"template":[
]
},
{
"id": 24,
"event": "Test 4",
"time": 240,
"color": "red",
"hex_color": "#ff0000",
"template":[
{
"Marker Name": "Test"
},
{
"Notes": "Test"
}
]
}
]
}
}

Failure Response

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