Versions Compared

Old Version 10

changes.mady.by.user Sofya Uyutova

Saved on

compared with

New Version 11

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://example.com:[port]IP-address:port/web2/secure/configuration/?pageItems={pageItems=N}&page={page=M} –  

Request parameters:

ParameterIs requiredDescription
pageItems=NNoSets the page number of a page displayed as a result . N > of the request. pageItems > 0. By default, N  pageItems=1.
page=MNoSets the number of objects displayed on the page. M >  page > 0. By default, M page=1000.


Note
titleImportantAttention!

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:

JSON:

Code Block
languagexmljs
[
    {
        "id": "1",<baseObjects>
  <STREAMING_SERVER>
    <extId>1</extId>
    "name": "Zone 1",
     <id>STREAMING_SERVER:1</id>
   "regions": [
       <name>RTSP    Server 1</name>
{
               <state>
 "id": "1.1",
                <id>normal</id>
 "zoneId": "1",
                "name":  <type>NORMAL</type>"Region 1.1",
    </state>            "zoneDescription": "Zone description"
    <type>STREAMING_SERVER</type>
        }
      <cams>1;</cams>  ]
    <port>554</port>},
    {
        "id": "2",
        "name": "Zone 2",
        "regions": [
            {
                "id": "2.1",
                "zoneId": "2",
                "name": "Region 2.1",
                "zoneDescription": "Zone description"
            }
        ]
    }
]

XML:

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<baseObjects>
  </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>1</displayId>
        <displayName>Display 6<1</displayName>
        <extId>1<<extId>5</extId>
     <geo_angle>0.0</geo_angle>
   <id>CAM:1<5</id>
        <latitide>43.47727<<monitorId>1</latitide>monitorId>
   <longitude>43.602381</longitude>
   <monitorId>7</monitorId>
   <monitorName>Monitor 7</monitorName>
   <name>Camera 1</name>
   <regionId />
   <state>
     <monitorName>Monitor 1</monitorName>
        <name>Камера 5</name>
        <regionDescription>Region description</regionDescription>
        <regionId>2.1</regionId>
        <regionName>Region 2.1</regionName>
        <state>
            <fullState>DISARMED</fullState>
            <id>disconnected<<id>connected</id>
           <type>ALARM< <type>NORMAL</type>
        </state>
        <type>CAM</type>
   <additionalInfo />
     <zoneId>2</zoneId>
        <zoneName>Zone 2</zoneName>
        <additionalInfo></additionalInfo>
     <micId   <micId></>micId>
        <presets />
       <speakerId <speakerId></>speakerId>
      <telemetryId  <telemetryId></>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
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 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.