Перейти в хранилище документации
Обратиться в техническую поддержку
...
GET http://IP-адрес:порт/web2/secure/configuration?pageItems={pageItems}&page={page}&{objectClass}={objectClass}&{objectId}={objectId}
Параметр | Обязательный | Описание |
---|---|---|
pageItems | Нет | Задает количество объектов, выводимых на странице. Значение должно быть больше 0, по умолчанию page=1000. Параметр page применяется только вместе с указанием параметра pageItems |
page | Нет | Задает номер страницы, отображаемой в результате запроса. pageItems > 0. По Значение должно быть больше 0, по умолчанию pageItems=1 |
objectClass | Нет | Идентификатор класса объектов. Пример: GRELE, MACRO, CAM |
objectIdpage | НетЗадает количество объектов, выводимых на странице. page > 0. По умолчанию page=1000. | Класс объекта и Id объекта, который указывается через двоеточие. Примеры: CAM:1, GRAY:5, PEOPLE_COUNTER:1 |
Note | ||
---|---|---|
| ||
Если в системе много объектов (>1000), то необходимо использовать постраничный вывод. |
Обработка всех объектов производится перебором страниц , до получения пустого массива.
...
Пример в формате JSON:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "1",
"name": "Area 1",
"regions": [
{
"id": "1.1",
"zoneId": "1",
"name": "Region 1.1",
"zoneDescription": "Описание зоны"
}
]
},
{
"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:
Code Block | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <baseObjects> <CAM> <displayId>1</displayId> <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> <displayName>Экран<name>Display 1</displayName>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> <monitorName>Монитор 1</monitorName><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> <name>Камера 5<</name>STREAMING_SERVER> <CAM> <regionDescription>Описание зоны<<displayId>1</regionDescription>displayId> <extId>1</extId> <regionId>2.1</regionId><geo_angle>0.0</geo_angle> <id>CAM:1</id> <latitide>-98.3293</latitide> <regionName>Раздел 2.1</regionName> <longitude>56.741</longitude> <monitorId>1;2</monitorId> <name>Camera 1</name> <regionDescription /> <regionId>1.1</regionId> <state> <regionName>Region 1.1</regionName> <state> <fullState>DISARMED</fullState> <id>connected</id> <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> </state>SLAVE> <baseObject> <type>CAM< <displayId>1</type>displayId> <extId>2</extId> <zoneId>2</zoneId> <id>MONITOR:2</id> <monitorId>2</monitorId> <zoneName>Область 2</zoneName> <name>Monitor 2</name> <state> <id>normal</id> <type>NORMAL</type> </state> <type>MONITOR</type> </baseObject> <baseObject> <additionalInfo>< <displayId>1</additionalInfo>displayId> <extId>1</extId> <micId><<id>MONITOR:1</micId>id> <monitorId>1</monitorId> <name>Monitor <presets/> 1</name> <state> <speakerId><<id>normal</speakerId> id> <type>NORMAL</type> <telemetryId><</telemetryId>state> <type>MONITOR</type> </CAM>baseObject> </baseObjects> |
Параметр | Описание |
---|---|
Общие параметры | |
extId | Идентификатор объекта |
id | Тип и идентификатор объекта в формате ТИП:ID |
name | Название объекта |
state | Состояние объекта. В параметрах Описание параметров <id> и <type> указано состояние в терминах API, подробнее , <type> и <fullState> см. в разделе Состояние отдельного объекта |
type | Тип объекта |
Особые параметры | |
cams | Список камер в RTSP-сервере через точку с запятой |
port | Порт, используемый RTSP-сервером |
regionDescription | Описание разделаобласти |
regionId | Идентификатор раздела, в который добавлен объект |
regionName | Название раздела |
zoneId | Идентификатор области, в который которую добавлен объект |
zoneName | Название области |
latitide | Широта (координата объекта при наличии геопривязки).). Параметр имеет ненулевое значение в следующих случаях:
|
longitude | Долгота (координата объекта при наличии геопривязки).). Параметр имеет ненулевое значение в следующих случаях:
|
monitorId | Для камеры: идентификатор монитора, на который добавлена камера. Если идентификаторов несколько, они разделяются точкой с запятой |
monitorName | Для камерымонитора: название монитора, на который добавлена камера. |
geo_angle | Для камеры: угол обзора (см. Настройка отображения угла обзора камеры на Карте) |
additionalInfo | Для камеры: значение поля Дополнительная информация |
micId | Для камеры: идентификатор связанного микрофона. |
presets | Для камеры: список предустановок. |
speakerId | Для камеры: идентификатор связанного динамика. |
telemetryId | Для камеры: идентификатор устройства управления телеметрией. |
displayId | Для интерфейсных объектов: идентификатор экрана. Если идентификаторов несколько, они разделяются точкой с запятой |
displayName | Для интерфейсных объектовэкрана: название экрана. |
camList | Для монитора: список идентификаторов камер, добавленных в монитор, разделенные точкой с запятой |