IVSWikiBlue: Created page with "This API call will add a new marker to the specified recording. This call can be used on a recording in progress. ===Resource URL===

http://valt.example.com/api/v3//reco..."

2020-04-14T19:53:11Z

Created page with "This API call will add a new marker to the specified recording. This call can be used on a recording in progress. ===Resource URL=== <pre>http://valt.example.com/api/v3//reco..."

New page

This API call will add a new marker to the specified recording. This 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'''
|POST
|-
|'''Headers'''
|Content-Type:application/json
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===
The JSON body must be properly formatted. All fields and values should be enclosed in double quotes and separated by a colon.
{|class="wikitable"
!colspan="2"|Field Name
!Description
!Required
!Example
|-
|colspan="2"|'''event'''
|Marker Name
|yes
|Confession
|-
|colspan="2"|'''time'''
|Time index in seconds in the recording where the marker will be inserted. An invalid time index can cause an error with the API call.
|yes
|127
|-
|colspan="2"|'''template'''
|Array of JSON objects containing the field ids and values for the marker template.
|no
|{"14":"Confession witnessed by officers Jones and Smith"}
|-
|
|'''{fieldid}'''
|Primary group ID for the new user.
|no
|Confession witnessed by officers Jones and Smith
|}

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Marker Added Successfully
|-
|400
|Invalid Request (See Response for Specific Error)
|-
|401
|Unauthorized
|-
|500
|JSON Body Formatted Incorrectly
|}

{|class="wikitable"
|+JSON Response
!colspan="2"|data
|-
|'''marker_add'''
|true = marker added successfully, false = marker could not be added
|-
|'''id'''
|ID number for the new marker.
|-
|'''message'''
|Detailed Status Message
|}

==Examples==
===Request===
The sample JSON body below is formatted with line breaks and indentation to make it easier to read. This is '''not''' required.
<pre>https://ivstest1.ad.ipivs.com/api/v3/records/616/markers?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"event":"API Marker 3",
"time":30,
"template":
{
"9":"12345678",
"10":"Test Note"
}
}
</nowiki>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"data":{
"marker_add": true,
"id": 31,
"message": "marker add"
}
}
</nowiki>

===Failure Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"error":{
"code": 500,
"message": "Internal Server Error"
}
}

</nowiki>

API Add Marker - Revision history

IVSWikiBlue: Created page with "This API call will add a new marker to the specified recording. This call can be used on a recording in progress. ===Resource URL===
http://valt.example.com/api/v3//reco..."