Параметры запроса
Параметр
|
Описание
|
Примечание
|
acl-priority
|
Приоритет, отдаваемый списку разрешенных или запрещенных адресов
|
Допустимые значения: allow, deny.
По умолчанию allow
|
add-acl-allow
|
Добавить адрес в разрешенные адреса
|
Параметры могут быть указаны в запросе неограниченное количество раз
|
add-acl-disallow
|
Добавить адрес в запрещенные адреса
|
add-group
|
Добавить группу
|
|
city
|
Город
|
|
delete-acl-allow
|
Удалить адрес из разрешенных адресов
|
Параметры могут быть указаны в запросе неограниченное количество раз
|
delete-acl-disallow
|
Удалить адрес из запрещенных адресов
|
delete-group
|
Удалить группу
|
|
department
|
Отдел
|
|
description
|
Описание
|
|
email
|
Адрес электронной почты для станции
|
|
floor
|
Этаж
|
|
id
|
Идентификатор станции
|
Обязательный параметр: да
|
latitude
|
Широта
|
|
longitude
|
Долгота
|
|
organization
|
Организация
|
|
parent-group
|
Родительская группа
|
|
password
|
Пароль
|
|
province
|
Область
|
|
room
|
Помещение
|
|
street
|
Улица
|
|

|
Если в запросе задать пустое значение для параметра password, то пароль будет изменен.
|
Формат задания параметров add-acl-allow, add-acl-disallow, delete-acl-allow и delete-acl-disallow: <protocol>/<address>/<mask>, где:
Параметр
|
Описание
|
Обязательный
|
Значение по умолчанию
|
<address>
|
IP-адрес или доменное имя
|
да
|
|
<mask>
|
маска сети
|
нет
|
255.255.255.255 (/32)
|
<protocol>
|
протокол TCP/IP (также IPv6)
|
нет
|
TCP/IP
|

|
Для корректного выполнения запроса с использованием параметров delete-acl-allow и delete-acl-disallow для них необходимо указывать префикс сети. Например:
http://192.168.1.1:9080/api/stations/change.ds?id=1002&delete-acl-allow=192.168.10.34/32&delete-acl-disallow=192.168.10.1/32
|
|

|
Если в параметре delete-group задается текущая первичная группа, то она не будет удалена из списка групп (параметр игнорируется).
Если в параметре delete-group задается текущая первичная группа и при этом происходит смена первичной группы (задан параметр parent-group), то меняется первичная группа и старая группа удаляется из списка.
|
Пример запроса
http://192.168.1.1:9080/api/stations/change.ds?id=1002&password=passwd&name=station1002&description=description
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.0" timestamp="1495740729" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<station id="1002"/>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <station /> содержит информацию об измененной станции.
Атрибут элемента <stations />:
Атрибут
|
Описание
|
id
|
Идентификатор измененной станции
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1555740761,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "50171907-d21d-b211-b3fd-cc152f024d8c"}},
"data": {
"id": "1002"}}
|
Описание параметров ответного JSON
Блок data содержит информацию об измененной станции.
Элемент блока data:
Название поля
|
Описание
|
id
|
Идентификатор измененной станции
|
|