|
Request Parameters
Parameter
|
Description
|
Valid values
|
Mandatory
|
id
|
Tariff group identifier.
This parameter can be defined in the request several times to request information on multiple groups at a time. Information on the Operating system, Status, or Ungrouped system groups can be provided in the same way.
|
-
|
yes
|
rights
|
If this parameter value is yes, then response will contain information about group rights.
The default value is no.
|
yes | no
|
no
|
keys
|
If this parameter value is yes, then response will contain information about the license key for this group.
The default value is no.
|
yes | no
|
no
|
Request Example
http://192.168.1.1:9080/api/groups/info.ds?id=123123123&rights=yes&keys=yes
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1391503753" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<groups total="1">
<group id="123123123" name="TEST-GROUP" description="" created="1394706331" modified="1394706331" parent_id="" parent_name="" type="0">
<rights inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<right code="1" name="Run Dr.Web Scanner for Windows" value="1"/>
<right code="2" name="Start SpIDer Guard for Windows XP" value="1"/>
<!-- etc. Skipped in documentation -->
<right code="93" name="" value="1"/>
<right code="94" name="" value="1"/>
</rights>
<keys />:
<keys inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<key id="22be0dead6fce942-0cb7d1ec6596a783"/>
</keys>
<packages>
<package arch="all" os="android" url="http://192.168.1.1:9080/download/download.ds?os=android&group-id=80cb36ea-51a1-e411-1a8f-a812b90b705f"/>
<package arch="all" os="macosx" url="http://192.168.1.1:9080/download/download.ds?os=macosx&group-id=80cb36ea-51a1-e411-1a8f-a812b90b705f"/>
<package arch="x86_64" os="linux" url="http://192.168.1.1:9080/download/download.ds?os=linux&arch=x86_64&group-id=80cb36ea-51a1-e411-1a8f-a812b90b705f"/>
<package arch="x86" os="linux" url="http://192.168.1.1:9080/download/download.ds?os=linux&arch=x86&group-id=80cb36ea-51a1-e411-1a8f-a812b90b705f"/>
<package arch="all" os="windows" url="http://192.168.1.1:9080/download/download.ds?os=windows&group-id=80cb36ea-51a1-e411-1a8f-a812b90b705f"/>
</packages>
<child-groups/>
<stations>1</stations>
</group>
</groups>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <groups /> element contains information about all 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
|
id
|
Group identifier.
|
created
|
Group creation time and date in Unix timestamp format.
|
modified
|
Group modification time and date in Unix timestamp format.
|
name
|
Group name.
|
description
|
Group description.
|
parent_id
|
Parent group identifier. If the value is none, then the parent group has not been set.
|
parent_name
|
Parent group name. If the value is none, then the parent group has not been set.
|
type
|
Group type. Is always 0.
|
•The <rights /> element contains information about all rights of a group. The <rights /> element attributes:
Attribute
|
Description
|
inherited
|
If its value is set to true, then rights are inherited from a parent group, and if set to false—then rights are configured individually.
|
inherited_group_id
|
ID of a parent group from which the rights have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which the rights have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
▫The <right /> element contains information about a specific element of rights. The <right /> element attributes:
Attribute
|
Description
|
code
|
Digital code of an element of rights. See the Permissions section.
|
name
|
Name of element of right. See the Permissions section.
|
value
|
Value of element of right. See the Permissions section.
|
•The <keys /> element contains information about all group keys. The <keys /> element attributes:
Attribute
|
Description
|
inherited
|
If its value is set to true, then the keys are inherited from a parent group, and if set to false, then keys parameters are configured individually.
|
inherited_group_id
|
ID of a parent group from which keys parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which keys parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
▫The <key /> element contains information about a specific key. The <key /> element attributes:
Attribute
|
Description
|
id
|
Key identifier
|
•The <packages /> element contains links on group installation packages created at this Server for different architectures and operating systems. ▫The <package /> element contains the link on the specific installation package. The <package /> element attributes:
Attribute
|
Description
|
arch
|
Architecture on which the package can be installed:
•all—operating systems with any bitness, •x86—32-bit operating systems, •x86_64—64-bit operating systems. |
os
|
Operating system on which the package can be installed
|
url
|
URL for the package (Agent) downloading
|
•The <child-groups /> element contains the number of child groups. •The <stations /> element contains information about all stations, included in the group. Value of this element is the number of stations included to this group.
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1411394801,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "20546124-e03f-e411-0aa6-a4d5c8ad7f2c"
}
},
"data": {
"groups": {
"total": 1,
"list": [{
"stations": 0,
"type": 1,
"created_time": 1411119266,
"modified_time": 1411119266,
"id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"has_personal_settings": true,
"permissions": {
"inherited": false,
"list": [{
"value": 1,
"right": 1,
"name": "Run Dr.Web Scanner for Windows"
},{
"value": 1,
"right": 2,
"name": "Start SpIDer Guard for Windows XP"
},{
"value": 1,
"right": 82,
"name": "Edit Dr.Web Cloud Checker for Android configuration"
}
]
},
"child_groups": 0,
"name": "Everyone",
"packages": [{
"url": "http://192.168.1.1:9080/download/download.ds?group-id=20e27d73-d21d-b211-a788-85419c46f0e6&os=android",
"os": "android",
"arch": "all"
},{
"url": "http://192.168.1.1:9080/download/download.ds?group-id=20e27d73-d21d-b211-a788-85419c46f0e6&os=windows",
"os": "windows",
"arch": "all"
}],
"keys": {
"inherited": false,
"list": [
"2e2522cc3ba5062f-aed721bcef305d0e"
]},
"description": "All stations"
}
]
}
}
}
|
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 specific groups. Elements in the list array:
Field name
|
Description
|
id
|
Group identifier
|
has_personal_settings
|
If the value is true, then personal settings have been set for the group or for some stations in the group, and if set to false, then no personal settings have been set.
|
modified_time
|
Group modification time and date in Unix timestamp format. Is always the same as the created attribute.
|
created_time
|
Group creation time and date in Unix timestamp format
|
type
|
Group type. Is always 0.
|
stations
|
Number of stations in the groups
|
name
|
Group name
|
child_groups
|
Number of child groups
|
▫The packages array block contains links on group installation packages created at this Server for different architectures and operating systems. Elements in the packages array:
Field name
|
Description
|
arch
|
Architecture on which the package can be installed:
•all—operating systems with any bitness, •x86—32-bit operating systems, •x86_64—64-bit operating systems. |
os
|
Operating system on which the package can be installed
|
url
|
URL for the package (Agent) downloading
|
▫The permissions block contains information about all rights of a group. The permissions block elements:
Field name
|
Description
|
inherited
|
If its value is set to true, then rights are inherited from a parent group, and if set to false—then rights are configured individually.
|
inherited_group_id
|
ID of a parent group from which the rights have been inherited. If the inherited field value is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which the rights have been inherited. If the inherited field value is set to false, then this attribute value will be none.
|
▪The list array in the permissions contains information about a specific element of rights. Elements in the list array:
Field name
|
Description
|
right
|
Digital code of an element of rights. See the Permissions section.
|
name
|
Name of element of right. See the Permissions section.
|
value
|
Value of element of right. See the Permissions section.
|
▫The keys block contains information about all license keys of a group. The keys block elements:
Field name
|
Description
|
inherited
|
If its value is set to true, then keys are inherited from a parent group, and if set to false—then keys are configured individually.
|
inherited_group_id
|
ID of a parent group from which the keys have been inherited. If the inherited field value is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which the keys have been inherited. If the inherited field value is set to false, then this attribute value will be none.
|
▪The list array in the keys contains information about a specific key. Elements in the list array
Field name
|
Description
|
id
|
Key identifier
|
|
