|
Request Example
http://192.168.1.1:9080/api/admins/list.ds
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1395828205"
server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<administrators total="4">
<administrator id="1" login="adm1" group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" group_name="Administrators"/>
<administrator id="2" login="adm2" group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" group_name="Administrators"/>
<administrator id="c9687f73-d21d-b211-a797-85419c46f0e6" login="admin" group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" group_name="Administrators"/>
<administrator id="70a1726e-d21d-b211-a9e1-840701ce1bdd" login="admin1" group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" group_name="Administrators"/>
<administrator id="30e68915-d21d-b211-a9eb-840701ce1bdd" login="admin5" group_id="de8d4d63-6ac1-4161-89fa-5f4ff82e866a" group_name="Newbies"/>
<administrator id="f0c8f065-d21d-b211-a9f4-840701ce1bdd" login="admin6" group_id="de8d4d63-6ac1-4161-89fa-5f4ff82e866a" group_name="Newbies"/>
</administrators>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <administrators /> element contains a list of all administrators. The <administrators /> element attributes:
Attribute
|
Description
|
total
|
Total number of administrators
|
▫The <administrator /> element contains information about a specific administrator account. The <administrator /> element attributes:
Attribute
|
Description
|
id
|
Account identifier
|
login
|
Account login
|
may_create_admin
|
Right to create other group administrators
|
group_id
|
Administrator group identifier
|
group_name
|
Administrator group name
|
JSON Response Structure
{
"head": {
"status": true,
"timestamp": 1411398630,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "20546124-e03f-e411-0aa6-a4d5c8ad7f2c"
}
},
"data": {
"total": 2,
"list": [
{
"id": "0001",
"group_name": "Administrators",
"login": "admin1",
"group_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d"
},
{
"id": "c9687f73-d21d-b211-a797-85419c46f0e6",
"group_name": "Administrators",
"login": "admin",
"group_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d"}]}}
|
Description of JSON Response Parameters
•The admins block contains a list of all administrators. The admins block elements:
Field name
|
Description
|
total
|
Total number of administrators
|
▫The list array of the admins block contains information about a specific administrator account. Elements in the list array:
Field name
|
Description
|
id
|
Account identifier
|
login
|
Account login
|
group_id
|
Group identifier
|
group_name
|
Group name
|
|
