|
Параметры запроса
Параметр
|
Описание
|
Примечание
|
acl-allow
|
Разрешенные адреса
|
Обязательные параметры: нет.
Могут быть указаны в запросе неограниченное количество раз.
|
acl-disallow
|
Запрещенные адреса
|
acl-priority
|
Приоритет списка разрешенных или списка запрещенных адресов
|
Обязательный параметр: нет.
Значения: allow, deny. По умолчанию allow
|
city
|
Город
|
Обязательный параметр: нет
|
country
|
Страна
|
Обязательный параметр: нет.
Задается в формате iso: RU, UA и т. д.
|
department
|
Отдел
|
Обязательный параметр: нет
|
description
|
Описание
|
Обязательный параметр: нет
|
email
|
Адрес электронной почты станции
|
Обязательный параметр: нет
|
floor
|
Этаж
|
Обязательный параметр: нет
|
group
|
Группы
|
Обязательный параметр: нет
|
id
|
Идентификатор станции
|
Обязательный параметр: нет.
Если параметр не задан, то он будет сгенерирован автоматически.
|
latitude
|
Широта
|
Обязательные параметры: нет.
Параметры задаются в десятичном формате (например, 38.898556, -77.037852).
|
longitude
|
Долгота
|
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
|
Пример запроса
http://192.168.1.1:9080/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.0" timestamp="1495740729" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<station id="1001"/>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <station /> содержит информацию о созданной станции.
Атрибут элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор созданной станции
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1393491700,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "7209d122-3b23-4134-94a9-0c1c645e21f3"}},
"data": {
"id": "1001"}}
|
Описание параметров ответного JSON
Блок data содержит информацию о созданной станции.
Элемент блока data:
Название поля
|
Описание
|
id
|
Идентификатор созданной станции
|
|