|
Request Parameters
Parameter
|
Description
|
Mandatory
|
parent-group
|
Parent group identifier.
Response contains information on all child groups of a parent group (without nesting). Information on child groups of the Operating system, Status, or Ungrouped system groups can be provided in the same way.
If parameter is not set, response contains information on all user groups of the Everyone group level.
|
no
|
Request Example
http://192.168.1.1:9080/api/groups/list.ds?parent-group=320bb310-7144-4e48-9772-ad8578a150f4
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1392870064" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<groups total="2">
<group id="98c8f98a-16e9-4fb5-af4d-d62923dca7b3" name="New2" child_groups="0" stations="0"/>
<group id="3" name="New3" child_groups="0" stations="0"/>
</groups>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <groups /> element contains a list of groups. The <groups /> element attributes:
Attribute
|
Description
|
total
|
Total number of groups
|
▫The <group /> element contains information about a specific group. The <group /> element attributes:
Attribute
|
Description
|
Note
|
id
|
Group identifier
|
|
name
|
Group name
|
|
child-groups
|
Number of child groups including nested child groups
|
|
stations
|
Number of stations in the group
|
|
JSON Response Structure
{"head": {
"status": true,
"timestamp":1392870208,
"api":{
"version":40103},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "7209d122-3b23-4134-94a9-0c1c645e21f3"}},
"data":{
"groups": {
"total": 2,
"list": [ {
"id":"98c8f98a-16e9-4fb5-af4d-d62923dca7b3",
"name":"New2",
"child_groups":0,
"stations":0
} , {
"id":"3",
"name":"New3",
"child_groups":0,
"stations":0}]}}}
|
Description of JSON Response Parameters
•The groups block contains information about all requested groups. The groups block elements:
Field name
|
Description
|
total
|
Total number of groups
|
▫The list array contains information about a specific group. Elements in the list array:
Field name
|
Description
|
Note
|
id
|
Group identifier
|
|
name
|
Group name
|
|
child-groups
|
Number of child groups including nested child groups
|
|
stations
|
Number of stations in the group
|
|
|
