*executeAction

Configuration Article | CA-20220907-TP-37

VDG Sense | API | Functions | Macros

Note: This function requires an API license.

This commands executes a specific action on a system. If a divaid is supplied, the action is send to the system with that id if available. Dependend on the system, viewer or server, and the action type, also viewer of server, the action will be executed.

A list with available actions can be obtained with the getActionList command. This command returns Ok if the syntax of the request is correct. It does not return the results of the action itself. The action to be executed should be send as POST information in XML format. Depending on the type of the action, several parameters should be applied. See examples below.

From version 2.3.1 the name and parameters can also be aplied in the url. To supply a parameter in the url, use the same name as the ‘name’ attribute of the parameter tag as used in the post data xml.

Request

command=executeAction&actionname=[string]&[parameter]=[value]

 

Alternatively, the parameters can also be posted in an XML body according to the following structure:

POST Data

<!--?xml version="1.0" ?-->  <action>   <actionname>[string]</actionname>   <parameters>     <parameter name="[string]">Value</parameter>     ...   </parameters>  </action>

 

POST Data Tags

node

value

remarks

node

value

remarks

/action

actionname

[string]

unique name of the action

/action/parameters

parameter

[string]

Value of the parameter

/action/parameters/parameter

@name

[string]

unique name of the parameter.


Possible error codes:

error code

description

remarks

error code

description

remarks

0

Ok

Ok, no error

-2

No device

No device found for the supplied cameraid/deviceid.

-17

No server

No server found for the supplied serverid.

-18

General error

An undefined error occured

-19

No dome

The device is not a dome device.

-22

Value is out of range

The supplied value is out of range.

-23

An empty value is not allowed

This command does not accept an empty value.

-24

Invalid action

The action is not a valid action.

-26

Action name does not exist

The supplied action name does not exist.

-27

Invalid action parameters

At least one action parameter does not exist.

-31

Invalid pretime

The supplied pretime is <0

Changelog

  • 2.3.17 – parameter ‘name’ for action name is changed to ‘actionname’

  • 2.3.1 – name and parameters can also be aplied in the url

  • 2.2.1 – added

Examples

All examples are included in the chapter Examples. Below is a list of currently supported actions. Use the command getActionList to determine if the system you interface with actually supports the action.

  • Set device settings

  • Change camera name

  • Disable home preset

  • Set home preset timeout

  • Start tagging video (Video tagging)

  • Stop tagging video (Video tagging)

  • Execute macro