|
Request Parameters
Parameter
|
Description
|
Valid values
|
Note
|
Mandatory
|
id
|
Administrator account identifier
|
Digits, latin characters, and symbols ‘_’, ’-‘
|
If not set, an ID will be generated automatically.
|
no
|
login
|
Login
|
Digits, latin characters, and symbols ‘_’, ’-‘
|
|
yes
|
password
|
Password
|
Digits, latin characters, and symbols ‘_’, ’-‘
|
If not set, a password will be generated automatically.
|
no
|
name
|
Name
|
-
|
|
no
|
last-name
|
Surname
|
-
|
|
no
|
middle-name
|
Middle name
|
-
|
|
no
|
description
|
Description
|
-
|
|
no
|
group
|
Identifier of a group which a newly-created administrator can access
|
-
|
This parameter can be defined in the request several times to specify multiple groups at a time. If this parameter is set in the request, then a group administrator account will be created.
|
no
|
readonly
|
A flag to create a restricted group administrator account
|
yes | no
|
The default value is no. If the flag is set and its value is set to yes, then a read-only account will be created (see Permissions).
|
no
|
may-create-admin
|
A flag determines the right to create administrators and administrative groups
|
yes | no
|
By default is yes
|
|
|
If the readonly=yes and may-create-admin=yes parameters are specified simultaneously, the readonly parameter has the priority. I.e. read-only administrator cannot add or change settings of other administrative accounts.
|
Request Example
http://192.168.1.1:9080/api/admins/add.ds?login=newadm1&password=root&name=name&last-name=last-name&middle-name=middle-name&description=description&group=1&readonly=yes&may-create-admin=no
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">
<administrator id="30b889b6-d11d-b211-a9f7-840701ce1bdd"/>
</drweb-avdesk-api>
|
Description of XML Response Parameters
The <administrator /> element contains information about created administrator account.
The <administrator /> element attributes:
Attribute
|
Description
|
id
|
Identifier of the created account
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1395656827,
"api": {
"version": 40103,
"build": "201403051"
},
"server": {
"name": "192.168.10.144",
"version": 1000201707130,
"uuid": "1023dcd7-d11d-b211-896d-8804c0842edb"
}
},
"id": "10ccf4d9-d11d-b211-a9f9-840701ce1bdd"
}
|
Description of JSON Response Parameters
The data block contains information about the created administrator account.
The data block elements:
Field name
|
Description
|
id
|
Identifier of created administrator account
|
|
