Перейти в хранилище документации
Обратиться в техническую поддержку
Page History
Общий формат запроса:
GET http://example.com:[port]IP-адрес:порт/web2/secure/configuration?pageItems={pageItems}&page={page}&{objectClass}={objectClass}&{objectId}={objectId}
Параметры запроса:
| Параметр | Обязательный | Описание |
|---|---|---|
| pageItems | Нет | Задает количество объектов, выводимых на странице. Значение должно быть больше 0, по умолчанию page=1000. Параметр page применяется только вместе с указанием параметра pageItems |
| page | Нет | Задает номер страницы, отображаемой в результате запроса. Значение должно быть больше 0, по умолчанию pageItems=1 |
| objectClass | Нет | Идентификатор класса объектов. Пример: GRELE, MACRO, CAM |
| objectId | Нет | Класс объекта и Id объекта, который указывается через двоеточие. Примеры: CAM:1, GRAY:5, PEOPLE_COUNTER:1 |
| Note | ||
|---|---|---|
| ||
Если в системе много объектов (>1000), то необходимо использовать постраничный вывод. |
Обработка всех объектов производится перебором страниц до получения пустого массива.
Пример запроса:
GET http://127.0.0.1:8085/web2/secure/configuration
Пример ответа:
Запрос возвращает список следующих объектов с указанием состояния3&page=2 – запрос возвращает список следующих объектов:
- список камер, добавленных в Web-сервер, с указанием состояния, идентификаторов соответствующих микрофонов, динамиков, поворотного устройства, пресетов, а также мониторов и экранов, на которых отображаются камеры (см. также Выбор и настройка видеокамер для Web-сервера);
- список экранов и мониторов, на которых отображаются камеры, добавленные в Web-сервер;
- список камер, добавленных на карты, выбранные для использования Веб-сервером 2.0 (см. Выбор карт);
- список лучей;
- список реле;
- список макрокоманд;
- список RTSP-серверов с указанием используемых портов и добавленных в них камер;
- список областей и разделов.
...
JSON:
page – необязательный параметр. Задает номер страницы, отображаемой в результате запроса. По умолчанию 1.
pageItems – необязательный параметр. Задает количество объектов, выводимых на странице. По умолчанию 1000.
| Note | ||
|---|---|---|
| ||
Если в системе много объектов (>1000) необходимо использовать постраничный вывод. |
Обработка всех объектов производится перебором страниц, до получения пустого массива.
XML
...
| Code Block | ||
|---|---|---|
| ||
[ { "id": "1", |
...
"name": "Area 1", |
...
"regions": [ |
...
...
|
...
{ |
...
"id": "1.1", |
...
"zoneId": "1", |
...
"name": "Region 1.1", |
...
"zoneDescription": "Описание зоны" |
...
} |
...
] }, |
...
{ |
...
JSON
[ {...
"type": " |
...
DISPLAY", |
...
"id": " |
...
DISPLAY: |
...
1", |
...
"extId": " |
...
1", |
...
"name": " |
...
"regionId" : "2.1",...
Display 1", "displayId": "1", "state": |
...
{ "id": " |
...
normal", |
...
"type": " |
...
NORMAL" |
...
}, "presets" : [ ]}, {...
, "fullState": null } }, { "type": " |
...
MACRO", |
...
"id": " |
...
MACRO: |
...
2", |
...
"extId": " |
...
2", |
...
"name": " |
...
Macro 2", "state": |
...
{ "id": " |
...
normal", |
...
"type": "NORMAL" |
...
}, "presets" : [ ]}, {...
, "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" : "Relay 2",...
"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": |
...
"regionId" : "2.1",...
"Computer DESKTOP-JHRURJJ", "state": |
...
{ "id": " |
...
connected", |
...
"type": "NORMAL |
...
}}, {...
", "fullState": null } }, { "type": " |
...
MONITOR", |
...
"id": " |
...
MONITOR: |
...
1", |
...
"extId": " |
...
1", |
...
"name" : "Sensor 2",...
"name": "Monitor 1", "displayId": "1", "monitorId": "1", "state": |
...
{ "id": " |
...
normal", |
...
"type": |
...
} "NORMAL",
"fullState": null
},
"camList": [
"1"
]
}
] |
XML:
| Code Block | ||
|---|---|---|
| ||
<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> |
Параметры ответа:
| Параметр | Описание |
|---|---|
| Общие параметры | |
extId | Идентификатор объекта |
id | Тип и идентификатор объекта в формате ТИП:ID |
name | Название объекта |
state | Состояние объекта. Описание параметров <id>, <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 | Для монитора: список идентификаторов камер, добавленных в монитор, разделенные точкой с запятой |
...
Overview
Content Tools
- Printed by Atlassian Confluence 8.6.1