Page History

General request format:

http://example.com:[port]/web2/secure/configuration/?{pageItems=3N}&{page=2 – returns the list of the following objects with states:

cameras added to the Web-server with IDs oc linked microphones, dynamics, PTZ devices, presets (see also Selecting and configuring cameras for the Web-server module).
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.

Parameters:

M} –

Request parameters:

page – optional parameter.

Parameter	Is required	Description
pageItems=N	No

Sets the number of a page displayed as a result. N > 0. By default

:

, N = 1.

pageItems – optional parameter.


page=M	No	Sets the number of objects displayed on the page. M > 0. By default

:

, M= 1000.

Note

title	Important!

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:

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

Response example:

XML

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

cameras added to the Web-server with IDs oc linked microphones, dynamics, PTZ devices, presets (see also Selecting and configuring cameras for the Web-server module).
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.

Code Block

language	xml

<baseObjects>
  <STREAMING_SERVER>
    <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>
    <cams>1;</cams>
    <port>554</port>
  </STREAMING_SERVER>
  <MACRO>
    <extId>001</extId>
    <id>MACRO:001</id>
    <name>001

...

Lghtnng ON 01</name>
    <state>
     <id>normal</id>
     <type>NORMAL</type>
    </state>
    <type>MACRO</type>
  </MACRO>
  <CAM>
   <displayId>6</displayId>
   <displayName>Display 6</displayName>
   <extId>1</extId>
   <geo_angle>0.0</geo_angle>
   <id>CAM:1</id>
   <latitide>43.47727</latitide>
   <longitude>43.602381</longitude>

...

<monitorId>7</

...

monitorId>
   <monitorName>Monitor

...

7</

...

monitorName>
   <name>Camera

...

1</name>
   <regionId />

...

<state>
      <id>disconnected</id>
      <type>ALARM</type>

...

</state>

...

<type>CAM</type>
   <additionalInfo

...

/>
   <micId

...

/>
   <presets

...

/>
   <speakerId

...

/>
   <telemetryId

...

>
  </CAM>
</baseObjects>

Response parameters:

ParameterDescription
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 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
regionId
ID of the region to which the object is added.
latitideLatitude (object coordinate if geo binding is configured).
longitudeLongitude (object coordinate if geo binding is configured).
monitorIdFor camera: ID of the monitor to which the camera is added.
monitorNameFor camera: name of the monitor to which the camera is added.
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.
displayNameFor interface objects: display name.
JSON
[ {
  "type" : "CAM",
  "id" : "CAM:2",
  "extId" : "2",
  "name" : "Camera 2",
  "regionId" : "2.1",
  "state" : {
    "id" : "alarmed",
    "type" : "ALARM"
  },
  "presets" : [ ]
}, {
  "type" : "CAM",
  "id" : "CAM:1",
  "extId" : "1",
  "name" : "Camera 1",
  "state" : {
    "id" : "armed",
    "type" : "NORMAL"
  },
  "presets" : [ ]
}, {
  "type" : "GRAY",
  "id" : "GRAY:1",
  "extId" : "1",
  "name" : "Sensor 1",
  "state" : {
    "id" : "disconnected",
    "type" : "ALARM"
  }
}, {
  "type" : "GRELE",
  "id" : "GRELE:2",
  "extId" : "2",
  "name" : "Relay 2",
  "state" : {
    "id" : "disabled",
    "type" : "NORMAL"
  }
}, {
  "type" : "GRELE",
  "id" : "GRELE:1",
  "extId" : "1",
  "name" : "Relay 1",
  "regionId" : "2.1",
  "state" : {
    "id" : "disabled",
    "type" : "NORMAL"
  }
}, {
  "type" : "GRAY",
  "id" : "GRAY:2",
  "extId" : "2",
  "name" : "Sensor 2",
  "state" : {
    "id" : "disconnected",
    "type" : "ALARM"
  }
} ]

Page tree

Versions Compared

Old Version 9

New Version 10

Key

General request format:

Request parameters:

Request example:

Response example:

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 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
regionId	ID of the region to which the object is added.
latitide	Latitude (object coordinate if geo binding is configured).
longitude	Longitude (object coordinate if geo binding is configured).
monitorId	For camera: ID of the monitor to which the camera is added.
monitorName	For camera: 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.
displayName	For interface objects: display name.