Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • element - a structural unit in the system (sensor, device, e-mail notification, etc.);
  • module - a combination of elements that are combined in the system according to a structural feature (composite sensor, module uniting cameras or SMS notifications, etc.);
  • group - a combination of objects that are united in the system according to an arbitrary characteristic (user-defined).

JSON format

Device families VT855i, VT960i, VT855t support API requests in JSON format.

When accessing the server, you need to specify the CGI program to which the request is being sent. For general queries, this is "engine.htm". Thus, the full path will be http://192.168.0.193/engine.htm.

To exchange messages in JSON format, the MIME content type must be specified in the POST request header as 'Content-Type: application/json'.

Input requests should have the following format:

Code Block
{
  "auth":{
    "name":"guest", 
    "p":"guest", 
    "h":"35675e68f4b5af7b995d9205ad0fc43842f16450"
  }
}

Here "auth" is the querytype name of the request type.

Next come the "key:value" parameter pairs corresponding to the request type. You can see the names of these fields in the API description.

Response messages have the following format:

Code Block
{
  "user":{
    "id":"1",
    "k":"123456789",
    "name":"guest",
    "sread":"all,",
    "swrite":"all,",
    "cread":"",
    "cwrite":"",
    "gread":"all,",
    "gwrite":"all,",
    "mail":"",
    "phone":""
  }
}

Here "user" corresponds to the tag name for the XML structures defined in the API. Next follow are "key:value" parameter pairs.

Not all requests in JSON format are supported yet. As far as possible, we will fill in these gaps.
These requests are not yet implemented in JSON format:

  • all duplicator requests - dublcrtinfo, dublsettings, dublfirmware, dublsystemget, dublunitadd, dublunitdel, dublgetdb, dublreset;
  • all logic schemes requests - getlogic, dellogic, addlogic, disablelogic, offlogics, onlogics;
  • getelementlist.