Versions Compared

Old Version 3

changes.mady.by.user Tom Polman

Saved on

compared with

New Version Current

changes.mady.by.user Selena Letterie

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration Article | CA-20220907-TP-75

VDG Sense | API | Functions | Video Tagging

Image Modified

View file
nameCA-20220907-TP-75.pdf

Table of Contents

Note: This function requires an API license.

Update the video tag title and/or comment field. If a field is omitted, it’s value remains unchanged.
Returns the changed videotag.

Request

Code Block
command=updatevideotag&id=[UID]&title=[String]&comment=[String]

Response

Code Block
<result errorcode="0">
    <videotag>
        <id>[UID]</id>
        <serverid>[UID]</serverid> <!-- if zero tag is for all devices -->
        <deviceid>[UID]</deviceid> <!-- if zero tag is for all devices -->
        <startdate>[timestamp]</startdate>
        <videotagdate>[timestamp]</videotagdate>
        <enddate>[timestamp]</enddate>
        <title>[String]</title>
        <comment>[String]</comment>
    </videotag>
</result>

...

node/result

value

remarks

/result

@errorcode

[number]

See error codes below

/result/videotag

id

[UID]

unique id

serverid

[UID]

unique server id

deviceid

[UID]

unique device id

startdate

[timestamp]

Tags with a (local) timestamp >= startdate (pretime) are returned.

videotagdate

[timestamp]

Tags with a (local) timestamp = videotagdate are returned.

enddate

[timestamp]

Tags with a (local) timestamp <= enddate (posttime) are returned.

title

[string]

A user defined title

comment

[string]

A user defined comment

error code

description

remarks

0

Ok

Ok, no error

-18

General error

An undefined error occured

-26

Videotag does not exist

Videotag does not exist or can not be found

See Also

Changelog

  • 2.4.3 – Added- Added

  • 2.7.3 - Added parameter videotagdate