|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
block-begin
|
Дата (включительно) начала блокировки.
Параметр задается в формате YYYYMMDD или YYYYMMDDHHmmss.
|
нет
|
block-end
|
Дата (включительно) окончания блокировки.
Параметр задается в формате YYYYMMDD или YYYYMMDDHHmmss.
|
нет
|
id
|
Идентификатор группы
|
да
|
Пример запроса
https://192.168.1.1:9081/api/groups/blocking.ds?id=7ec98a70-5c83-11ea-512f-70a167e08535
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1584353601" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<stations total="2">
<station id="1004" status="failed"/>
<station id="1005" status="success"/>
</stations>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <stations /> содержит информацию об изменении параметров блокировки станций в группе, указанной в запросе.
Атрибут элемента <stations />:
Атрибут
|
Описание
|
total
|
Общее количество станций в ответе
|
•Элемент <station /> содержит информацию об изменении параметров блокировки конкретной станции.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
status
|
Статус изменения параметров блокировки:
•success — блокировка выполнена успешно,
•failed — блокировка не выполнена. |
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1584354370,
"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": {
"total": 2,
"list": {
"1004": "failed",
"1005": "success"}}}
|
Описание параметров ответного JSON
Блок data содержит информацию об изменении параметров блокировки станций в группе, указанной в запросе.
Элементы блока data:
Название поля
|
Описание
|
total
|
Общее количество станций в ответе
|
list
|
Блок с результатами изменения параметров блокировки для каждой станции
|
•Элементы блока list:
Название поля
|
Описание
|
Идентификатор станции
|
Статус изменения параметров блокировки:
•success — блокировка выполнена успешно,
•failed — блокировка не выполнена. |
|