Параметры запроса
Параметр |
Описание |
Обязательный |
|---|---|---|
acl-priority |
Приоритет, отдаваемый списку разрешенных или запрещенных адресов. Допустимые значения: allow, deny. По умолчанию: allow. |
нет |
add-acl-allow |
Добавить адрес в разрешенные адреса. Параметр может быть указан в запросе неограниченное количество раз. |
нет |
add-acl-disallow |
Добавить адрес в запрещенные адреса. Параметр может быть указан в запросе неограниченное количество раз. |
нет |
add-group |
Добавить группу |
нет |
city |
Город |
нет |
delete-acl-allow |
Удалить адрес из разрешенных адресов. Параметр может быть указан в запросе неограниченное количество раз. |
нет |
delete-acl-disallow |
Удалить адрес из запрещенных адресов. Параметр может быть указан в запросе неограниченное количество раз. |
нет |
delete-group |
Удалить группу |
нет |
department |
Отдел |
нет |
description |
Описание |
нет |
Адрес электронной почты для станции |
нет |
|
floor |
Этаж |
нет |
id |
Идентификатор станции |
да |
latitude |
Широта |
нет |
longitude |
Долгота |
нет |
organization |
Организация |
нет |
parent-group |
Родительская группа |
нет |
password |
Пароль |
нет |
country |
Страна. Задается в формате ISO: RU, UA и т. д. |
нет |
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 для них необходимо указывать префикс сети. Например:
|
|
Если в параметре delete-group задается текущая первичная группа, то она не будет удалена из списка групп (параметр игнорируется). Если в параметре delete-group задается текущая первичная группа и при этом происходит смена первичной группы (задан параметр parent-group), то меняется первичная группа и старая группа удаляется из списка. |
Пример запроса
https://192.168.1.1:9081/api/stations/change.ds?id=1002&password=password&name=station1002&description=description |
Ниже представлены примеры ответов в формате XML и в формате JSON.
<drweb-es-api api_version="4.3.2" timestamp="1582030254" server="192.168.1.1" srv_version="13.00.1.202310121" status="true"> <station id="1002"/> </drweb-es-api> |
Описание параметров ответного XML
Элемент <station /> содержит идентификатор станции, параметры которой изменены.
Атрибут элемента <stations />:
Атрибут |
Описание |
|---|---|
id |
Идентификатор станции |
{ "head": { "status": true, "timestamp": 1582030511, "api": { "version": 40302, "versionString": "4.3.2"}, "server": { "name": "192.168.1.1", "version": "13.00.1.202310121", "uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}}, "data": { "id": "1002"}} |
Описание параметров ответного JSON
Блок data содержит идентификатор станции, параметры которой изменены.
Элемент блока data:
Название поля |
Описание |
|---|---|
id |
Идентификатор станции |