⌂ > ⎘ Открытый REST API

GET /command?type=setguardian : Постановка канала на охрану🔗

Доступно во всех типах лицензий.

Предупреждение

Доступно в Macroscop версии 2.1 и выше.

Важно

Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.

Примечание

HTTP-интерфейс Macroscop позволяет не только получать сведения о системе, но и управлять некоторыми её элементами, выполняя описанные ниже CGI-запросы.

Такие запросы, за одним исключением, имеют следующий формат:

{Протокол}://{Сервер}:{Порт}/command?type={Тип}&login={Логин}&password={Пароль}&{Параметр}={Значение параметра}

Для изменения состояния режима охраны для канала используется тип запроса setguardian.

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

GET http://localhost:8080/command?type=setguardian&login=root&password=&clientip=192.168.1.2&monitor=0&channelid=20d9884f-ae8c-45d3-ac5a-505ec258f01b&isguardianmodeenabled=true

Дополнительные параметры запроса🔗

Параметр

Значение по умолчанию

Описание

clientip

—

IP адрес устройства, на котором запущено клиентское приложение Macroscop. Обязательный параметр

monitor

—

Номер монитора в действующей конфигурации клиентского приложения. Отсчёт начинается с 0. Обязательный параметр

channelid

—

Уникальный идентификатор канала. Может быть получен при выполнении запроса Получение конфигурации системы. Обязательный параметр

isguardmodeenabled

—

Переключение состояния режима охраны. Возможные значения: true – включить режим охраны, false – выключить. Обязательный параметр