Documentation for Intellect 4.10.4. Documentation for other versions of Intellect is available too.

Previous page Intellect HTTP API  Getting events Next page


HTTP API is represented by web2 module (Web-server 2.0).

Note.

See Administrator's Guide, Configuring the server for the clients connection via the Web-server 2.0 module section.

HTTP API allows the following features:

  1. Get information about interactive maps: map list, map name, map layer list, layer parameters, layer background image, information about the list of points and an individual point on the layer (see Map).
  2. Get information about object classes created on the Server, a list of states for the object class and information about status, icons for a specific state (see Object classes).
  3. Get a list of objects created on the server, information about the individual object, the state of the object, the list of available actions with the object (see Objects).
  4.  Receive events from the Server both separately and by blocks (see Getting events).
  5.  Send commands to the server (see Sending commands to server).
  6.  Run macros (see Macros).
  7.  Work with video: get frames, request configuration, receive live and archive video, manage recording, arm and disarm cameras, manage telemetry (see Video).
  8.  Use notification systems to subscribe an application to APNS messages (see Notification).
  9.  Get live and archive sound (see Sound).
  10.  Send events and reactions to the core of the Intellect software (see Sending reactions and events to Intellect using HTTP request).

The following notation is used in the examples shown in this section:

  • Port stands for port number. The default Web-server 2.0 module port is 8085. Specifying port in HTTP API commands is mandatory.
  • /web2 – web context where the web2 app operates. This is the web-app context.

Further the description will be omitted when query action is clear in the context.

Important!

URL, id of objects and file extension are case-sensitive.

Note.

Date and time are specified in RFC 3339 format, see details at http://www.ietf.org/rfc/rfc3339.txt
  • No labels