|
Request Parameters
Parameter
|
Description
|
Valid values
|
Note
|
Mandatory
|
id
|
Group identifier
|
Digits, latin characters, and the following symbols: ‘_’, ‘-’, ‘.’
|
If not set, an ID will be generated automatically
|
no
|
name
|
Group name
|
-
|
|
yes
|
description
|
Group description
|
-
|
|
no
|
parent-group
|
Parent group identifier
|
-
|
|
no—for full-rights administrators
yes—for group administrators
|
|
The parent-group parameter is obligatory for group creation by a user with group administrator rights.
|
Request Example
http://192.168.1.1:9080/api/groups/add.ds?id=4&name=group4&parent-group=1&description=descr
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1391503111" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<group id="4"/></drweb-avdesk-api>
|
Description of XML Response Parameters
The <group /> element contains information about the created group.
The <group /> element attributes:
Attribute
|
Description
|
id
|
Group identifier
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1395734862,
"api": {
"version": 40103},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "1023dcd7-d11d-b211-896d-8804c0842edb"}},
"data": {
"id": "4"}}
|
Description of JSON Response Parameters
The data block contains information on the created group.
The data block elements:
Field name
|
Description
|
id
|
Identifier of created group
|
|
