Page History

General request format:

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

Request parameters:

Parameter	Required	Description
pageItems	No	Specifies the number 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	Specifies the page number displayed as a result of the request. The value must be greater than 0, by default pageItems=1
objectClass	No	Identifier of an object class. Example: GRELE, MACRO, CAM
objectId	No	Object class and object Id, separated by a colon. Examples: CAM:1, GRAY:5, PEOPLE_COUNTER:1

Note

title	Attention!

If there are many objects in the system (>1000), you must use a page-by-page display.

All objects are processed page by page 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:

list of cameras added to the Web-server with IDs of corresponding 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);
list of displays and monitors on which the cameras added to the Web-server are displayed;
list of cameras, added to the maps, selected to be used by the Web Server 2.0 (see Selecting maps);
list of sensors;
list of relays;
list of macros;
list of RTSP servers with ports used, cameras added;
list of areas and regions.

JSON:

Expand

title	Click to expand...

Code Block

language	js

[
    {
        "id": "1",
        "name": "Area 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": "Macro 2",
        "state": {
            "id": "normal",
            "type": "NORMAL",
            "fullState": null
        }
    },
    {
        "type": "STREAMING_SERVER",
        "id": "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": {
            "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": "Monitor 1",
        "displayId": "1",
        "monitorId": "1",
        "state": {
            "id": "normal",
            "type": "NORMAL",
            "fullState": null
        },
        "camList": [
            "1"
        ]
    }
]

XML:

Expand

title	Click to expand...

Code Block

language	xml

<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>
      <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>
      <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>
      <extId>1</extId>
      <geo_angle>0.0</geo_angle>
      <id>CAM:1</id>
      <latitide>-98.3293</latitide>
      <longitude>56.741</longitude>
      <monitorId>1;2</monitorId>
      <name>Camera 1</name>
      <regionDescription />
      <regionId>1.1</regionId>
      <regionName>Region 1.1</regionName>
      <state>
         <fullState>DISARMED</fullState>
         <id>connected</id>
         <type>NORMAL</type>
      </state>
      <type>CAM</type>
      <zoneId>1</zoneId>
      <zoneName>Area 1</zoneName>
      <additionalInfo />
      <micId />
      <presets />
      <speakerId />
      <telemetryId />
   </CAM>
   <SLAVE>
      <extId>COMP</extId>
      <id>SLAVE:COMP</id>
      <name>LOCALHOST</name>
      <state>
         <id>connected</id>
         <type>NORMAL</type>
      </state>
      <type>SLAVE</type>
   </SLAVE>
   <baseObject>
      <displayId>1</displayId>
      <extId>2</extId>
      <id>MONITOR:2</id>
      <monitorId>2</monitorId>
      <name>Monitor 2</name>
      <state>
         <id>normal</id>
         <type>NORMAL</type>
      </state>
      <type>MONITOR</type>
   </baseObject>
   <baseObject>
      <displayId>1</displayId>
      <extId>1</extId>
      <id>MONITOR:1</id>
      <monitorId>1</monitorId>
      <name>Monitor 1</name>
      <state>
         <id>normal</id>
         <type>NORMAL</type>
      </state>
      <type>MONITOR</type>
   </baseObject>
</baseObjects>

...

Page tree

Versions Compared

Old Version 3

New Version Current

Key

General request format:

Request parameters:

Request example:

Response example: