Versions Compared

Old Version 21

changes.mady.by.user Darya Andryieuskaya

Saved on

compared with

New Version 22

changes.mady.by.user Gleb Matskevich

Saved on

Key

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

General request format:

GET http://IP-address:port/web2/secure/configuration?pageItemspage={pageItemspage}&pagepageItems={pagepageItems} 

Request parameters:

of objects displayed on the page. page > 0. By default, page=1000.
ParameterIs requiredDescription
pageItemspageNo

Sets the

page

number

displayed as a result of the request. pageItems > 0. By default, pageItems=1.page

of objects displayed on the page. The value must be greater than 0, by default page=1000.

The page parameter only applies when the pageItems parameter is specified

pageItemsNo

Sets the page number

displayed as a result of the request. The value must be greater than 0, by default pageItems=1


Note
titleAttention!

If there are many objects in the system (>1000) they are to be displayed by pages.

Processing of all objects is performed page by pare until an empty array is received.

Request example:

GET http://127.0.0.1:8085/web2/secure/configuration

Response example:

The request returns the list of the following objects with states:

  • cameras added to the Web-server with IDs of linked microphones, dynamics, PTZ devices, presets, as well as monitors and displays to which the camera added (see also Selecting and configuring cameras for the Web-server module);
  • displays and monitors on which the cameras added to the Web-server are displayed;
  • cameras added to maps selected for Web Server 2.0 are returned – see Selecting maps;
  • sensors;
  • relays;
  • macros;
  • RTSP servers with ports used, cameras added;
  • list of zones and regions.

JSON:

...


ParameterDescription
General parameters

extId

Object ID

id

Object type and ID in the format TYPE:ID

name

Object name

state

Object state. The <id>, <type> and <fullState> description see in State of a specific object.

type

Object type
Specific parameters

cams

List of cameras added to the RTSP Server with semicolon as a separator.

port

Port used by RTSP Server
regionDescriptionRegion description

regionId

ID of the region to which the object is added
regionNameRegion name
zoneIdID of the zone to which the object is added
zoneNameZone name
latitideLatitude (object coordinate).

The parameter has non-zero value if:

  1. An external map is used for the layer background (see Configuring the external Map server), or
  2. The layer is tied to geo coordinates (see Configuring map binding to coordinate grid).
longitudeLongitude (object coordinate).

The parameter has non-zero value if:

  1. An external map is used for the layer background (see Configuring the external Map server), or
  2. The layer is tied to geo coordinates (see Configuring map binding to coordinate grid).
monitorIdFor camera: ID of the monitor to which the camera is added. If there are several IDs, they are separated by a semicolon ";"
monitorNameFor monitor: name of the monitor
geo_angleFor camera: viewing angle (for camera, see Configuring the camera viewing angle display on the Map)
additionalInfo For camera: the Additional info field value
micId For camera: the ID of the associated microphone.
presets For camera: preset list.
speakerId For camera: the ID of the associated speaker.
telemetryId For camera: the ID of the PTZ control panel.
displayIdFor interface objects: display ID. If there are several IDs, they are separated by a semicolon ";"
displayNameFor display: display name.
camListFor monitor: IDs of cameras added to the monitor separated by semicolon ";"