Page History

General request format:

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

Request parameters:

Parameter	Is required	Description
pageItems	No	Sets the

page page

number

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

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

page

No	Sets the page number

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

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

Note

title	Attention!

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:

Code Block

language	js

[
    {
        "id": "1",
        "name": "ZoneArea 1",
        "regions": [
            {
                "id": "1.1",
                "zoneId": "1",
                "name": "Region 1.1",
                "zoneDescription": "Zone description"
            }
        ]
    },
    {
        "type": "DISPLAY",
        "id": "DISPLAY:1",
        "extId": "1",
        "name": "Display 1",
        "displayId": "1",
        "state": {
            "id": "normal",
            "type": "NORMAL",
            "fullState": null
        }
    },
    {
        "type": "MACRO",
        "id": "MACRO:2",
        "extId": "2",
        "name": "Zone 2",
Macro 2",
        "state": {
            "id": "normal",
            "type": "NORMAL",
            "regionsfullState": [null
        }
    },
    {
        "type": "STREAMING_SERVER",
        "id": "2.1",
   STREAMING_SERVER:1",
        "extId": "1",
        "name": "RTSP Server 1",
        "state": {
            "id": "normal",
            "type": "NORMAL",
            "fullState": null
        },
        "port": "554",
        "cams": "1;;;;;;"
    },
    {
        "type": "CAM",
        "id": "CAM:1",
        "extId": "1",
        "name": "Camera 1",
        "displayId": "1",
        "monitorId": "1",
        "state": {
             "zoneId": "2"id": "connected_recording",
            "type": "NORMAL",
            "fullState": "DISARMED|RECORDER_ON|RECORDING"
        },
        "presets": []
    },
    {
        "type": "SLAVE",
        "id": "SLAVE:COMP",
        "extId": "COMP",
        "name": "Computer DESKTOP-JHRURJJ",
        "state": {
            "id": "connected",
            "type": "NORMAL",
            "fullState": null
        }
    },
    {
        "type": "MONITOR",
        "id": "MONITOR:1",
        "extId": "1",
        "name": "Region 2. "Monitor 1",
        "displayId": "1",
        "monitorId": "1",
        "state": {
            "zoneDescriptionid": "normal",
            "Zone description"type": "NORMAL",
            "fullState": null
        },
        "camList": [
            "1"
        ]
    }
]

XML:

Code Block

language	xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<baseObjects>
    <CAM>
  <baseObjects>
   <CAM>
      <displayId>1</displayId>
      <extId>9</extId>
      <geo_angle>0.0</geo_angle>
      <id>CAM:9</id>
      <latitide>-98.0533</latitide>
      <longitude>56.4089</longitude>
      <monitorId>1;2</monitorId>
      <name>Camera 9</name>
      <regionId />
      <state>
         <fullState>DISARMED</fullState>
         <id>connected</id>
         <type>NORMAL</type>
      </state>
      <type>CAM</type>
      <additionalInfo />
      <micId />
      <presets />
      <speakerId />
      <telemetryId />
   </CAM>
   <baseObject>
      <displayId>1</displayId>
      <extId>1</extId>
     <displayName>Display 1</displayName>
   <id>DISPLAY:1</id>
      <name>Display 1</name>
      <state>
         <id>normal</id>
         <type>NORMAL</type>
      </state>
      <type>DISPLAY</type>
   </baseObject>
   <CAM>
      <displayId>1</displayId>
      <extId>5</extId>
      <geo_angle>0.0</geo_angle>
      <id>CAM:5</id>
      <latitide>-97.6674</latitide>
      <longitude>56.3588</longitude>
      <monitorId>1</monitorId>
      <name>pos</name>
      <regionId />
      <state>
         <fullState>DISARMED</fullState>
         <id>connected</id>
         <type>NORMAL</type>
      </state>
      <type>CAM</type>
      <additionalInfo />
      <micId />
      <presets />
      <speakerId />
      <telemetryId />
   </CAM>
   <STREAMING_SERVER>
      <cams>1;2;3;4;5;6;9;;;;;;;;;;</cams>
    <monitorName>Monitor 1</monitorName>
     <extId>1</extId>
      <id>STREAMING_SERVER:1</id>
      <name>RTSP Server 1</name>
      <state>
         <id>normal</id>
         <type>NORMAL</type>
      </state>
      <type>STREAMING_SERVER</type>
      <port>5543</port>
   </STREAMING_SERVER>
   <CAM>
      <displayId>1</displayId>
     <name>Камера 5<<extId>1</name>extId>
      <geo_angle>0.0</geo_angle>
     <regionDescription>Region description<<id>CAM:1</regionDescription>id>
      <latitide>-98.3293</latitide>
      <regionId>2.1</regionId>
  <longitude>56.741</longitude>
      <monitorId>1;2</monitorId>
      <name>Camera 1</name>
      <regionDescription />
      <regionId>1.1</regionId>
      <regionName>Region 21.1</regionName>
      <state>
         <fullState>DISARMED</fullState>
           <state>
  <id>connected</id>
         <type>NORMAL</type>
      </state>
      <type>CAM</type>
      <zoneId>1</zoneId>
      <zoneName>Area 1</zoneName>
      <additionalInfo />
      <micId />
      <presets />
      <speakerId />
      <telemetryId />
   <fullState>DISARMED<</fullState>CAM>
   <SLAVE>
      <extId>COMP</extId>
    <id>connected<  <id>SLAVE:COMP</id>
      <name>LOCALHOST</name>
      <state>
         <id>connected</id>
         <type>NORMAL</type>
      </state>
      <type>SLAVE</type>
   </state>SLAVE>
   <baseObject>
      <type>CAM<<displayId>1</type>displayId>
      <extId>2</extId>
      <zoneId>2<<id>MONITOR:2</zoneId>id>
      <monitorId>2</monitorId>
   <zoneName>Zone   <name>Monitor 2</zoneName>name>
      <state>
         <id>normal</id>
         <type>NORMAL</type>
      </state>
      <type>MONITOR</type>
   <additionalInfo></additionalInfo></baseObject>
   <baseObject>
      <displayId>1</displayId>
  <micId></micId>    <extId>1</extId>
        <presets/><id>MONITOR:1</id>
      <monitorId>1</monitorId>
      <name>Monitor 1</name>
      <state>
        <speakerId>< <id>normal</speakerId>id>
        <telemetryId></telemetryId>
  <type>NORMAL</type>
      </state>
      <type>MONITOR</type>
   </CAM>baseObject>
</baseObjects>

Response parameters:

Parameter	Description
General parameters
extId	Object ID
id	Object type and ID in the format TYPE:ID
name	Object name
state	Object state. The <id>

and <type> parameters show the state in the API terms, see

, <type> and <fullState> description see in State of a specific object

fir details.


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
regionDescription	Region description
regionId	ID of the region to which the object is added
regionName	Region name
zoneId	ID of the zone to which the object is added
zoneName	Zone name
latitide	Latitude (object coordinate). The parameter has non-zero value if: An external map is used for the layer background (see Configuring the external Map server), or The layer is tied to geo

binding is configured).

coordinates (see Configuring map binding to coordinate grid)

longitude

Longitude (object coordinate).

The parameter has non-zero value if:

An external map is used for the layer background (see Configuring the external Map server), or
The layer is tied to geo

binding is configured).

coordinates (see Configuring map binding to coordinate grid)
monitorId	For camera: ID of the monitor to which the camera is added. If there are several IDs, they are separated by a semicolon ";"
monitorName	For

camera

monitor: name of the monitor

to which the camera is added.


geo_angle	For 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

.


displayId	For interface objects: display ID. If there are several IDs, they are separated by a semicolon ";"
displayName	For

interface objects

display: display name

.


camList	For monitor: IDs of cameras added to the monitor separated by semicolon ";"

Page tree

Versions Compared

Old Version 11

New Version Current

Key

General request format:

Request parameters:

Request example:

Response example:

Response parameters: