|
Request Parameters
Parameter
|
Description
|
Note
|
Mandatory
|
login
|
Administrator account login
|
This parameter can be defined in the request several times to request information on multiple administrators at a time
|
yes
|
Request Example
http://192.168.1.1:9080/api/admins/info.ds?login=adm1&login=adm2
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1395658257" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<administrators total="2">
<administrator id="1" login="adm1" description="" created="1395654901" modified="1395654901" name="" last_name="" middle_name="" may_create_admins="yes" group_id="123123123" group_name="TEST-GROUP" external="no"/>
<administrator id="2" login="adm2" description="description" created="1395655048" modified="1395655114" name="name" last_name="last-name" middle_name="middle-name" may_create_admins="no" group_id="777" group_name="NEW-GROUP" external="no"/>
</administrators>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <administrators /> element contains information about all administrators whose logins have been submitted in the request. The <administrators /> element attributes:
Attribute
|
Description
|
total
|
Total number of administrators about which the information have been returned
|
▫The <administrator /> element contains information about a specific administrator account. The <administrator /> element attributes:
Attribute
|
Description
|
id
|
Account identifier
|
login
|
Account login
|
name
|
Name
|
last_name
|
Surname
|
middle_name
|
Middle name
|
may_create_admin
|
Right to create other group administrators
|
description
|
Description
|
created
|
Account creation time and date in Unix timestamp format
|
modified
|
Account modification time and date in Unix timestamp format
|
group_id
|
Identifier of a group which a specified administrator can access
|
group_name
|
Name of a group which a specified administrator can access
|
external
|
The type of administrator authorization. False value means internal administrator, while true stands for administrator with authorization via the external systems.
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp":1410514584,
"api":{
"version":40103 },
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "70c5f522-aaab-4c93-a180-a442a0da9c2a" }},
"data":{
"admins": {
"total": 1,
"list": [{
"id":"c9687f73-d21d-b211-a797-85419c46f0e6",
"login":"admin",
"description":"Default administrator account",
"created_time":1410329555,
"modified_time":1410514584,
"name":null,
"last_name":null,
"middle_name":null,
"external":false,
"may_create_admins": true,
"group_id": "777",
"group_name": "NEW-GROUP" } ]}
}}
|
Description of JSON Response Parameters
The data block contains information about all administrators.
The data block elements:
Field name
|
Description
|
total
|
Total number of administrators about which the information have been returned
|
•The list array contains information about a specific administrator account. Elements in the list array:
Field name
|
Description
|
id
|
Account identifier
|
login
|
Account login
|
description
|
Description
|
created_time
|
Account creation time and date in Unix timestamp format
|
modified_time
|
Account modification time and date in Unix timestamp format
|
name
|
Name
|
last_name
|
Surname
|
middle_name
|
Middle name
|
external
|
The type of administrator authorization. False value means internal administrator, while true stands for administrator with authorization via the external systems.
|
may_create_admins
|
Right to create other group administrators
|
group_id
|
Identifier of a group which a specified administrator can access
|
group_name
|
Name of a group which a specified administrator can access
|
|
