Versions Compared

Key

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

General request format:

GET http://example.com:[port]IP-address:port/web2/secure/video/config.properties?version=4.7.8.0{version}&login=XXX{login}&password=YYY

Parameters:

  • version – mandatory field. Client version (if protocol is changed). Now the 4.7.8.0 value is to be sent.
  • login – optional field.
  • password - optional field. It is in use if access is protected with the password.

...

{password}

Request parameters:

Parameter

Is required

Description

versionYesSee Product version
login NoIntellect username, if set
password NoIntellect user password, if set

Example request:

GET http://127.0.0.1:8085

At the start it is not clear if the login and password are in use. To make it clear, send the following query:

GET

http://www.examplehost.com/web2/secure/video/config.properties?version=4.7.8.0

The server sends back the config.properties text file:

password.enabled=true
login.enabled=true
password.invalid=true#
Info
titleNote.
# symbol means the ending of configuration file.

When you get this file, it becomes clear that the password has been set and it is not correct. It is not correct because the login and password fields were blank.

Request the login and password and send configuration query to the server once again:

GET

&login=USER&password=PASS

Example response:

Config.properties text file.

If a password is set but not specified in the request:

Code Block
languagexml
password.enabled=true
login.enabled=true
password.invalid=true#

...

If the password is correct or access is allowed without the password, then the server sends the following configuration:

Code Block
languagexml
password.enabled=true

...


login.enabled=true

...


password.invalid=false

...


cam.0.id=2

...


cam.0.name=Face

...


cam.0.rights=11

...


cam.1.id=3

...


cam.1.name=Camera 3

...


cam.1.rights=11

...


cam.2.id=5

...


cam.2.name=Camera 5

...


cam.2.rights=11

...


cam.2.telemetry_id=1.1

...


cam.count=3#

...

Response parameters:

ParameterDescription
password.

...

Info
titleNote.
If access is allowed without the password, then password.enabled=false and configuration will be received on the first try.
enabled

false - no password required

true - password required

login.enabled

false - no login required

true - login required

password.invalid

false - specified password is correct

true - specified password is not correct

cam.countTotal count

...

of cameras in the configuration (id starts at 0)

...

.
cam.N.id

...

Camera ID
cam.N.name

...

Camera name

...

cam.N.

...

rights

...

cam.N.telemetry_id – telemetry id (there can be no value if there is no telemetry – then hide telemetry control elements).

...

Rights (they are checked on the server; available on the client in order not to show the user odd options). The parameter is represented by flags. If the flag is set, then the interface element is to be shown; if not – hidden.

...

static final int RIGHT_VIEW = 0x1;  //  live video is available (always 1)

...

static final int RIGHT_CONTROL = 0x2; // control (telemetry, arming and disarming)

...

static final int RIGHT_CONFIG = 0x4;  // reserved

...

static final int RIGHT_HISTORY = 0x8; //

...

 access to archive

cam.N.telemetry_idTelemetry ID (there can be no value if there is no telemetry – then hide telemetry control elements).