|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
group
|
Идентификатор группы.
Параметр может быть указан в запросе неограниченное количество раз для добавления станции в несколько групп одновременно.
|
нет
|
id
|
Идентификатор станции.
Параметр может быть указан в запросе неограниченное количество раз для восстановления нескольких станций одновременно.
Если удаленная станция с переданным идентификатором не найдена, то в ответном документе этот идентификатор будет указан в блоке fail.
|
да
|
parent-group
|
Идентификатор первичной группы.
Если параметр не задан, то станция будет восстановлена в той же первичной группе, в которой была при удалении.
|
нет
|
Пример запроса
http://192.168.1.1:9080/api/stations/restore.ds?id=1000&id=1001&id=1002
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.0" timestamp="1527436692" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<success total="2">
<station>1000</station>
<station>1001</station>
</success>
<fail total="1">
<station>1002</station>
</fail>
</drweb-es-api>
|
Описание параметров ответного XML
•Элемент <success /> содержит информацию обо всех восстановленных станциях. Атрибут элемента <success />:
Атрибут
|
Описание
|
total
|
Общее количество станций
|
▫Элемент <station /> содержит идентификатор восстановленной станции. •Элемент <fail /> содержит информацию о несуществующих идентификаторах удаленных станций, если такие идентификаторы были переданы в запросе. Атрибут элемента <fail />:
Атрибут
|
Описание
|
total
|
Общее количество идентификаторов станций
|
▫Элемент <station /> содержит несуществующий идентификатор станции, переданный в запросе.
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1557453053,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "6d63ec4f-68f7-40ad-a389-8a57a042d3ed"}},
"data": {
"success": {
"total": 2,
"list": [
"1000",
"1001"]},
"fail": {
"total": 1,
"list": [
"1002"]}}}
|
Описание параметров ответного JSON
•Блок success содержит информацию обо всех восстановленных станциях. Элементы блока success:
Название поля
|
Описание
|
total
|
Общее количество станций
|
list
|
Массив содержит идентификаторы восстановленных станций.
|
•Блок fail содержит информацию о несуществующих идентификаторах удаленных станций, если такие идентификаторы были переданы в запросе. Элементы блока fail:
Название поля
|
Описание
|
total
|
Общее количество идентификаторов станций
|
list
|
Массив содержит несуществующие идентификаторы станций, переданные в запросе.
|
|