*getDeviceList

Configuration Article | CA-20220907-TP-61

VDG Sense | API | Functions | Servers & Devices

Obtains a list of all devices (cameras) available in the network.

Request

command=getDeviceList

Response

<result errorcode="0">   <devices count="[number]">     <device>       <name>[string]</name>       <serverid>[uid]</serverid>       <deviceid>[uid]</deviceid>       <status>[string] </status>       <type>[string] </type>       <brand>[string] </brand>       <location>[string] </location>       <ptztype>[string]</ptztype>       <ipaddress>[ip-address]</ipaddress>       <port>[number]</port>     </device>   </devices> </result>

node

value

remarks

node

value

remarks

/result

@errorcode

[number]

See error codes below

/result/devices

@count

[number]

number of devices

/result/devices/device

name

[string]

the name of the device

serverid

[UID]

unique server id

deviceid

[UID]

unique camera id

status

[string]

status of the device, see Camera Status

type

[string]

type of the device, i.e. "camera"

brand

[string]

brand of the device, i.e. "VDG"

location

[string]

location of the device

ptztype

[string]

ptz type of the device, i.e. "VDG"

ipaddress

[ip-address]

The ip adress of the device

port

[number]

the port of the device

error code

description

remarks

error code

description

remarks

0

Ok

Ok, no error

 Changelog

  • 2.7.2 – Added ipaddress and port nodes

  • 2.3.18 – Device list is alphabetically sorted by device name

  • 1.10.1 – Added

Related pages