|
Request Parameters
This request does not contain any parameters.
Request Example
https://192.168.1.1:9081/api/admins/list.ds
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.0" timestamp="1582030266" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<adm1inistrators total="2">
<administrator id="admin1" login="adm1" group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" group_name="Administrators" may_create_admin="true" permission="allow"/>
<groups>
<group id="GroupForCAF1-1">GroupForCAF1-1</group>
<group id="GroupForCAF1-2">GroupForCAF1-2</group>
</groups>
</administrator>
<administrator id="admin2" login="adm2" group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" group_name="Administrators" may_create_admin="false" permission="deny"/>
<groups> </groups>
</administrator>
</administrators>
</drweb-es-api>
|
Description of XML Response Parameters
The <administrators /> element contains a list of administrators in all administrator groups.
The <administrators /> element attribute:
Attribute
|
Description
|
total
|
Total number of administrators
|
•The <administrator /> element contains parameters of a specific administrator account. The <administrator /> element attributes:
Attribute
|
Description
|
group_id
|
Group ID
|
group_name
|
Group name
|
id
|
Account ID
|
login
|
Account login
|
may_create_admin
|
Authorization to create administrator accounts, administrator groups:
•true—authorized, •false—not authorized. |
permission
|
Access privileges:
•allow—access granted •deny—access denied. |
▫The <groups /> element contains information about all administrator groups an administrator is included in. The <groups /> element attribute:
Attribute
|
Description
|
total
|
Total number of administrator groups
|
▪The <group /> element contains information about a specific administrator group. The <group /> element attribute:
Attribute
|
Description
|
id
|
Administrator group ID
|
The <group /> element value is administrator group name.
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1582030523,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},
"data": {
"total": 2,
"list": [
{"group_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d"
"group_name": "Administrators",
"groups": {
"GroupForCAF1-1": "GroupForCAF1-1",
"GroupForCAF1-2": "GroupForCAF1-2"},
"id": "admin1",
"login": "adm1",
"may_create_admins": true,
"permission": "allow"},
{"group_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d"
"group_name": "Administrators",
"groups": [],
"id": "admin2",
"login": "adm2",
"may_create_admins": false,
"permission": "deny"}]}}
|
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
|
Group ID
|
group_name
|
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
|
Access privileges:
•allow—access granted •deny—access denied. |
▫The groups block elements:
Field name
|
Description
|
Administrator group ID
|
Administrator group name
|
|