|
Параметр запроса
Параметр
|
Описание
|
Обязательный
|
id
|
Идентификатор группы администраторов.
Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких группах администраторов одновременно.
|
да
|
Пример запроса
https://192.168.1.1:9081/api/admingroups/info.ds?id=adm1&id=adm2
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1588495732" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<admin-groups total="2">
<admin-group id="adm1" name="Gr-Admin-1" description="Default administrator group" modified="1588334566" parent_group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" parent_group_name="Administrators"/>
<admin-group id="adm2" name="Gr-Admin-2" description="" modified="1588334256" parent_group_id="777" parent_group_name="NEW-GROUP"/>
</admin-groups>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <admin-groups /> содержит информацию об группах администраторов, указанных в запросе.
Атрибут элемента <admin-groups />:
Атрибут
|
Описание
|
total
|
Общее количество групп администраторов в ответе
|
•Элемент <admin-group /> содержит параметры конкретной группы администраторов.
Атрибуты элемента <admin-group />:
Атрибут
|
Описание
|
id
|
Идентификатор группы
|
name
|
Название группы
|
description
|
Описание группы
|
modified
|
Дата и время модификации группы
|
parent_group_id
|
Идентификатор родительской группы администраторов
|
parent_group_name
|
Название родительской группы администраторов
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1588495959,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "78b77680-8080-11ea-701a-44a527d9115c"}},
"data": {
"admins": {
"total": 2,
"list": [
{"id": "adm1",
"description": "Default administrator group",
"modified_time": 1588334566,
"name": "Admin-1",
"parent_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d",
"parent_name": "Administrators"},
{"id": "adm2",
"description": "",
"modified_time": 1588334513,
"name": "Admin-2",
"parent_id": "777",
"parent_name": "NEW-GROUP"}]}}}
|
Описание параметров ответного JSON
Блок data содержит информацию о группах администраторов, указанных в запросе.
Элементы блока data:
Название поля
|
Описание
|
total
|
Общее количество групп администраторов в ответе
|
list
|
Массив параметров для каждой группы администраторов
|
•Каждый объект массива list содержит параметры конкретной группы администраторов.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор группы
|
description
|
Описание группы
|
modified_time
|
Дата и время модификации группы
|
name
|
Название группы
|
parent_id
|
Идентификатор родительской группы
|
parent_name
|
Название родительской группы
|
|