IVSWikiBlue at 17:01, 7 March 2025

2025-03-07T17:01:27Z

IVSWikiBlue: Created page with "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...."

2020-04-14T19:59:11Z

Created page with "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=== <pre>http://valt.example...."

New page

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===
<pre>http://valt.example.com/api/v3/records/{recordid}/markers</pre>
''Replace {recordid} with the actual id number of the record. Records are numbered sequentially when added to VALT.''

===Resource Information===
{|class="wikitable"
|'''Method'''
|GET
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===

No parameters can be passed to this call.

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Request Successful
|-
|401
|Unauthorized
|}

{|class="wikitable"
|+JSON Response
!colspan="4"|data
|-
|colspan="3"|'''markers'''
|Array of markers. (Will return an empty array if there are no markers in the video.)
|-
|
|colspan="2"|'''id'''
|Marker ID
|-
|
|colspan="2"|'''event'''
|Marker Name
|-
|
|colspan="2"|'''time'''
|Time index in seconds where the marker is located in the video.
|-
|
|colspan="2"|'''color'''
|Marker Color ([[Marker Colors|Valid Values]])
|-
|
|colspan="2"|'''hex_color'''
|Hex code for the specified color. ([[Marker Colors|Valid Values]])
|-
|
|colspan="2"|'''template'''
|Array of fields and data in the marker template.
|-
|
|
|'''{fieldname}'''
|Field Value
|}

==Examples==
===Request===
<pre>https://ivstest1.ad.ipivs.com/api/v3/records/616/markers?access_token=e82632d19c523678fea3d1016c6df9e9</pre>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"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"
}
]
}
]
}
}
</nowiki>

===Failure Response===
<pre>{"error":{"code":401,"message":"No API key provided"}}</pre>

API List Markers - Revision history

IVSWikiBlue at 17:01, 7 March 2025

IVSWikiBlue: Created page with "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...."

@@ Line 55: / Line 55: @@
+|
 |colspan="2"|'''color'''
-|Marker Color ([[Marker Colors|Valid Values]])
+|Marker Color
 |-
+|
 |colspan="2"|'''hex_color'''
-|Hex code for the specified color. ([[Marker Colors|Valid Values]])
+|Hex code for the specified color.
 |-
+|