*Usage
- Tom Polman
TKH Security Solution | Video Surveillance
VDG Sense | API | Usage
Versions - VDG Sense 2.6.x
Here developers can find how the API communicates and which commands can be used. Select one of the topics to get more information on that API subject.
The functions describes all the HTTP functions available. Every function describes its purpose, input and output parameters, and arguments. The HTTP request displayed is only the argument-part of the URL. For example, when the command describes a request as:
command=getDeviceListthe complete request for a VDG Sense setup at localhost should be:
http://127.0.0.1/command?command=getDeviceListEvery function chapter explains the following sections:
Description | This is the description of the function. |
Request | This describes the request to be send. |
Parameters | This is a list explaining all parameters from the request. Between [ and ] is the type. If the type is omitted, it is assumed to be of type string. |
Response | This describes the response. In most cases, the response is an xml message. If the answer is not the default answer, it is listed here. |
Tags | If the response is not the default answer, this list explains all tags from the result. Between [ and ] is the type. If the type is omitted, it is assumed to be of type string. |
See Also | Displays a list with useful links. |
Change log | Displays a list with changes for the function. |
Examples | Displays some examples if available. |