GET http://IP-address:port/web2/secure/configuration?pageItems={pageItems}&page={page}
| Parameter | Is required | Description |
|---|---|---|
| pageItems | No | Sets the page number displayed as a result of the request. pageItems > 0. By default, pageItems=1. |
| page | No | Sets the number of objects displayed on the page. page > 0. By default, page=1000. |
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.
GET http://127.0.0.1:8085/web2/secure/configuration
The request returns the list of the following objects with states:
JSON:
[
{
"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:R-GYZYEV",
"extId": "R-GYZYEV",
"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:
<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>R-GYZYEV</extId> <id>SLAVE:R-GYZYEV</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> |
| 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>, <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 |
| 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:
|
| longitude | Longitude (object coordinate). The parameter has non-zero value if:
|
| 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 monitor: name of the monitor |
| 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 display: display name |
| camList | For monitor: IDs of cameras added to the monitor separated by semicolon ";" |