Page Comparison

...

Configuration Article | CA-20220907-TP-67

VDG Sense | API | Functions | Status

Image Added

View file

name	CA-20220907-TP-67.pdf

Table of Contents

Note: This function requires an API license.

Obtains a list of all supported status types. The lists consists of name and description pairs. The name can be used in streamStatus.

Request

Code Block
command=getStatusTypes

Code Block
<result errorcode="0"> <statustypes count="[number]"> <statustype> <name>[string]</name> <description>[string]</description> </statustype> ... </statustypes> </result>

node	value	remarks
/result
@errorcode	[number]	See error codes below
/result/statustypes
@count	[number]	The number of status types
/result/statustypes/statustype
name	[string]	the name, as used in streamStatus
description	[string]	a system defined description of the status type

error code	description	remarks
0	Ok	Ok, no error
-18	General error	An undefined error occured