|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
acl-allow
|
Разрешенный адрес.
Параметр может быть указан в запросе неограниченное количество раз.
|
нет
|
acl-disallow
|
Запрещенный адрес.
Параметр может быть указан в запросе неограниченное количество раз.
|
нет
|
acl-priority
|
Приоритет списка разрешенных или списка запрещенных адресов.
Допустимые значения: allow, deny. По умолчанию: allow.
|
нет
|
city
|
Город
|
нет
|
country
|
Страна.
Параметр задается в формате iso: RU, UA и т. д.
|
нет
|
department
|
Отдел
|
нет
|
description
|
Описание
|
нет
|
disable-grace-period
|
Включение или отключение пробного периода, наследуемого от тарифа
|
нет
|
email
|
Адрес электронной почты станции
|
нет
|
floor
|
Этаж
|
нет
|
group
|
Группы
|
нет
|
id
|
Идентификатор станции.
Если параметр не задан, то он будет сгенерирован автоматически.
|
нет
|
latitude
|
Широта.
Параметр задается в десятичном формате (например, 38.898556, -77.037852).
|
нет
|
longitude
|
Долгота.
Параметр задается в десятичном формате (например, 38.898556, -77.037852).
|
нет
|
name
|
Название станции
|
нет
|
organization
|
Организация
|
нет
|
parent-group
|
Родительская группа
|
нет
|
password
|
Пароль
|
нет
|
province
|
Область
|
нет
|
room
|
Помещение
|
нет
|
street
|
Улица
|
нет
|
Формат задания параметров acl-allow и acl-disallow: <protocol>/<address>/<mask>, где:
Параметр
|
Описание
|
Обязательный
|
<address>
|
IP-адрес или доменное имя
|
да
|
<mask>
|
Маска сети.
Значение по умолчанию: 255.255.255.255 (/32).
|
нет
|
<protocol>
|
Протокол TCP/IP (также IPv6).
Значение по умолчанию: TCP/IP.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/stations/add.ds?id=1001&password=123456&name=station1234&acl-allow=192.168.1.1&acl-disallow=192.168.1.2&acl-priority=allow
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1582030254" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<station id="1001"/>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <station /> содержит идентификатор созданной станции.
Атрибут элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1582030511,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},
"data": {
"id": "1001"}}
|
Описание параметров ответного JSON
Блок data содержит идентификатор созданной станции.
Элемент блока data:
Название поля
|
Описание
|
id
|
Идентификатор станции
|
|