Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Общий формат запроса:

GET http://example.com:[port]IP-адрес:порт/web2/secure/configuration?{pageItems=3N}&{page=M}

Параметры запроса:

ПараметрОбязательныйОписание
pageItems=NНет Задает номер страницы, отображаемой в результате запроса. N > 0. По умолчанию N=1.
page=MНетЗадает количество объектов, выводимых на странице. M > 0. По умолчанию M=1000.


Note
titleВнимание!

Если в системе много объектов (>1000) необходимо использовать постраничный вывод.

 Обработка всех объектов производится перебором страниц, до получения пустого массива.

Пример запроса:

http://127.0.0.1:8085/web2/secure/configuration

Пример ответа:

Запрос =2 – запрос возвращает список следующих объектов с указанием состояния:

  • список камер, добавленных в Web-сервер, с указанием идентификаторов соответствующих микрофонов, динамиков, поворотного устройства, пресетов (см. также Выбор и настройка видеокамер для Web-сервера);
  • список камер, добавленных на карты, выбранные для использования Веб-сервером 2.0 (см. Выбор карт);
  • список лучей;
  • список реле;
  • список макрокоманд;
  • список RTSP-серверов с указанием используемых портов и добавленных в них камер.

Параметры:

page – необязательный параметр. Задает номер страницы, отображаемой в результате запроса. По умолчанию 1.

pageItems – необязательный параметр. Задает количество объектов, выводимых на странице. По умолчанию 1000.

Note
titleВнимание!

Если в системе много объектов (>1000) необходимо использовать постраничный вывод.

 Обработка всех объектов производится перебором страниц, до получения пустого массива.

Пример запроса

http://127.0.0.1:8085/web2/secure/configuration

Пример ответа

XML


Code Block
languagexml
<baseObjects>
  <STREAMING_SERVER>
    <extId>1</extId>
    <id>STREAMING_SERVER:1</id>
    <name>RTSP Сервер 1</name>
    <state>
      <id>normal</id>
      <type>NORMAL</type>
    </state>
    <type>STREAMING_SERVER</type>
    <cams>1;</cams>
    <port>554</port>
  </STREAMING_SERVER>
  <MACRO>
    <extId>001</extId>
    <id>MACRO:001</id>
    <name>001 ВКЛ Осв. 01</name>
    <state>
     <id>normal</id>
     <type>NORMAL</type>
    </state>
    <type>MACRO</type>
  </MACRO>
  <CAM>
   <displayId>6</displayId>
   <displayName>Экран 6</displayName>
   <extId>1</extId>
   <geo_angle>0.0</geo_angle>
   <id>CAM:1</id>
   <latitide>43.47727</latitide>
   

...

<longitude>43.602381</longitude>
   <monitorId>7</monitorId>
   <monitorName>Монитор 

...

7</

...

monitorName>
   <name>Камера 

...

1</name>
   <regionId />
   

...

<state>
      <id>disconnected</id>
      <type>ALARM</type>

...

   </state>
   

...

<type>CAM</type>
   <additionalInfo 

...

/>
   <micId 

...

/>
   <presets 

...

/>
   <speakerId 

...

/>
   <telemetryId 

...

/

...

>
  </CAM>
</baseObjects>

JSON

[ {
  "type" : "CAM",
  "id" : "CAM:2",
  "extId" : "2",
  "name" : "Camera 2",
  "regionId" : "2.1",
  "state" : {
    "id" : "alarmed",
    "type" : "ALARM"
  },
  "presets" : [ ]
}, {
  "type" : "CAM",
  "id" : "CAM:1",
  "extId" : "1",
  "name" : "Camera 1",
  "state" : {
    "id" : "armed",
    "type" : "NORMAL"
  },
  "presets" : [ ]
}, {
  "type" : "GRAY",
  "id" : "GRAY:1",
  "extId" : "1",
  "name" : "Sensor 1",
  "state" : {
    "id" : "disconnected",
    "type" : "ALARM"
  }
}, {
  "type" : "GRELE",
  "id" : "GRELE:2",
  "extId" : "2",
  "name" : "Relay 2",
  "state" : {
    "id" : "disabled",
    "type" : "NORMAL"
  }
}, {
  "type" : "GRELE",
  "id" : "GRELE:1",
  "extId" : "1",
  "name" : "Relay 1",
  "regionId" : "2.1",
  "state" : {
    "id" : "disabled",
    "type" : "NORMAL"
  }
}, {
  "type" : "GRAY",
  "id" : "GRAY:2",
  "extId" : "2",
  "name" : "Sensor 2",
  "state" : {
    "id" : "disconnected",
    "type" : "ALARM"
  }

Параметры ответа:

ПараметрОписание
Общие параметры

extId

Идентификатор объекта

id

Тип и идентификатор объекта в формате ТИП:ID

name

Название объекта

state

Состояние объекта. В параметрах <id> и <type> указано состояние в терминах API, подробнее см. Состояние отдельного объекта

type

Тип объекта
Особые параметры
cams
Список камер в RTSP-сервере через точку с запятой
port
Порт, используемый RTSP-сервером
regionId
Идентификатор региона, в который добавлен объект.
latitideШирота (координата объекта при наличии геопривязки).
longitudeДолгота (координата объекта при наличии геопривязки).
monitorIdДля камеры: идентификатор монитора, на который добавлена камера.
monitorNameДля камеры: название монитора, на который добавлена камера.
geo_angleДля камеры: угол обзора (см. Настройка отображения угла обзора камеры на Карте)
additionalInfo Для камеры: значение поля Дополнительная информация
micId Для камеры: идентификатор связанного микрофона.
presets Для камеры: список предустановок.
speakerId Для камеры: идентификатор связанного динамика.
telemetryId Для камеры: идентификатор устройства управления телеметрией.
displayIdДля интерфейсных объектов: идентификатор экрана.
displayNameДля интерфейсных объектов:название экрана.

...