Get a List of Administrator Groups

Request Parameters

This request does not contain any parameters.

Request Example

https://192.168.1.1:9081/api/admingroups/list.ds

XML and JSON response structure examples are described below.

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1588503818" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<admin-groups total="5">
<admin-group id="0d20c3f0-8d2c-11ea-6efe-502672a1498e" parent_id="fe76cc50-8d2b-11ea-6efc-502672a1498e" parent_name="new1" name="new1" description=""/>

<admin-group id="c11ced50-8ba3-11ea-625e-502672a1498e" parent_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" parent_name="Administrators" name="456" description="new456"/>

<admin-group id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" parent_id="" parent_name="" name="Administrators" description="Root administrator group"/>

<admin-group id="de8d4d63-6ac1-4161-89fa-5f4ff82e866a" parent_id="" parent_name="" name="Newbies" description="Administrator group for automatically created administrators"/>

<admin-group id="fe76cc50-8d2b-11ea-6efc-502672a1498e" parent_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" parent_name="Administrators" name="new" description=""/>
</admin-groups>
</drweb-es-api>

Description of XML Response Parameters

The <admin-groups /> element contains a list of administrator groups.

The <admin-groups /> element attribute:

Attribute	Description
total	Total number of administrator groups

•The <admin-group /> element contains parameters of a specific administrator group.

The <admin-group /> element attributes:

Attribute	Description
id	Administrator group ID
parent_id	Parent group ID
parent_name	Parent group name
name	Administrator group name
description	Administrator group description

JSON Response Structure

{ "head": {
"status": true,

"timestamp": 1588504097,

"api": {
"version": 40300,
"versionString": 4.3.0},

"server": {
"name": "192.168.1.1",

"version": "13.00.0.202005090",
"uuid": "78b77680-8080-11ea-701a-44a527d9115c"}},

"data": {
"total": 5,

"list": [
{"id": "0d20c3f0-8d2c-11ea-6efe-502672a1498e",

"name": "new1",

"parent_id": "fe76cc50-8d2b-11ea-6efc-502672a1498e",
"parent_name": "new"},

{"description": "new456",
"id": "c11ced50-8ba3-11ea-625e-502672a1498e",

"name": "456",

"parent_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d",
"parent_name": "Administrators"},

{"description": "Root administrator group",
"id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d",

"name": "Administrators"},

{"description": "Administrator group for automatically created administrators",
"id": "de8d4d63-6ac1-4161-89fa-5f4ff82e866a",

"name": "Newbies"},

{"id": "fe76cc50-8d2b-11ea-6efc-502672a1498e",

"name": "new",

"parent_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d",
"parent_name": "Administrators"}]}}

Description of JSON Response Parameters

The data block contains a list of administrators in all administrator groups.

The data block elements:

Field name	Description
total	Total number of administrators
list	Array of parameters for each administrator account

•Each object of the list array contains parameters of a specific administrator account.

Elements in the list array:

Field name	Description
id	Account ID
login	Account login
group_id	Parent administrator group ID
group_name	Parent administrator group name
groups	This block contains information about all administrator groups that include the administrator
may_create_admins	Authorization to create administrator accounts, administrator groups: •true—authorized, •false—not authorized.
permission	Granting access privileges: •allow—access allowed •deny—access denied.

▫The groups block elements:

Field name	Description
Administrator group ID	Administrator group name