Syntax Conventions - Polycom VSX Series Integrator's Reference Manual

Integrator's Reference Manual for the VSX Series

Syntax Conventions

3 - 2
The following conventions are used for the API commands.
All of the commands are case sensitive
Convention Meaning
<param> Required parameter. Multiple parameters are separated by the
pipe ("|") character.
<param1|param2>
Example: allowdialing <yes|no|get>
This shows that the allowdialing command must be followed by
one of the arguments listed.
[param] Optional parameter. Quotation marks indicate strings to be sup-
plied by the user.
["param"]
Example: adminpassword <set|get> ["password"]
This shows that the adminpassword command can be used to
set a password defined by the user. Use quotation marks when
entering strings that contain spaces.
To set My VSX Password as the administrator password, you
would enter this command:
adminpassword set "My VSX Password"
{a..z} Range of alphanumeric values.
Example: abk letter <{a..z}>
This shows that the abk command can be used to return
address book entries that begin with an alphanumeric character
in the range specified.
{n..nn} Range of numeric values.
Example: camera near <{1..4}>
This shows that the camera command can be used to select
camera 1, 2, 3, or 4 at the near site.
"n" A number of any value.
Although the API command parser accepts the minimum number of characters in a
command which makes it unique, you should always use the full command string when
writing applications to run the VSX system. The shortcuts are merely to save time when
testing or developing an application.
.
www.polycom.com/videodocumentation