Get Tariff Group Information

Parameter	Description	Valid values	Note	Mandatory
id	Subscription group ID	-	The parameter can be defined in the request as many times as you like to request information on multiple groups at a time	yes
components	If this parameter value is yes, then response will contain information about tariff group components	yes, no	The default value is no	no
rights	If this parameter value is yes, then response will contain information about tariff group rights	yes, no	The default value is no	no
keys	If this parameter value is yes, then response will contain information on tariff group license keys	yes, no	The default value is no	no

http://192.168.1.1:9080/api/tariffs/info.ds?id=my_tariff&components=yes&rights=yes

<drweb-avdesk-api api_version="4.1.3" local_timestamp="1293705273" server="192.168.1.1" srv_version="10.01.0.201707130" status="true" timestamp="1293683673">
<groups total="1">
<group id="91644cc3-1dc1-42dc-a41e-5ea001f5538d" name="Dr.Web Premium" description="Antivirus & Antispam & Parental Control customers" created="1428916071" modified="1428916071" parent_id="994992e8-be71-4d31-a1f5-5b7786262611" parent_name="Tariffs" type="11" custom_tariff="false" grace_period="30">
<components inherited="true" inherited_group_id="994992e8-be71-4d31-a1f5-5b7786262611" inherited_group_name="Tariffs">
<component code="105" name="Dr.Web (R) Firewall" status="1" />
<component code="4" name="Dr.Web (R) Scanner for Windows" status="1" />
<component code="34" name="SpIDer Guard (R) for Windows Server" status="1" />
<component code="6" name="SpIDer Guard (R) for Windows XP" status="1" />
<component code="14" name="SpIDer Mail (R) for Windows Workstations" status="1" />
<component code="38" name="SpIDer Gate (R) for Windows Workstations" status="1" />
<component code="103" name="Dr.Web (R) Microsoft Outlook plugin" status="1" />
<component code="55" name="VadeRetro (C) Antispam" status="1" />
<component code="54" name="Dr.Web (R) Parental Control" status="1" />
</components>
<rights inherited="false" inherited_group_id="none" inherited_group_name="none">
<right code="53" name="Uninstall Dr.Web(R) Agent" value="1" />
<right code="27" name="Disable self-protection" value="1" />

<right code="8" name="Change SpIDer Mail(R) for Windows Workstations configuration" value="1" />
<right code="10" name="Stop SpIDer Mail(R) for Windows Workstations" value="1" />
</rights>
<child-groups total="11"/>
<stations total="1"/>
</group>
</groups>
</drweb-avdesk-api>

Attribute	Description
id	Tariff group ID
created	Group creation time and date in Unix timestamp format
modified	Group modification time and date in Unix timestamp format
name	Tariff group name
description	Tariff group description
parent_id	Parent group ID
parent_name	Parent group name
type	Group type. Is always 11.
custom_tariff	The attribute is set to true if the requested tariff group is custom. Otherwise, the attribute is set to false.

▫The <components /> element contains information about all tariff group components.

Attribute	Description
inherited	If its value is set to true, then components are inherited from a parent group, and if set to false, then component parameters are configured individually.
inherited_group_id	ID of a parent group from which component 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 component parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.

Attribute	Description
code	Digital code of the component. See the Component codes section.
name	Component name. See the Component codes section.
status	Component status. See the Component codes section.

▫The <rights /> element contains information about all rights of a tariff group.

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.

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 <stations /> element contains information about all tariff group stations.

▫The <child-groups /> element contains information about all tariff child groups.

{ "head": {
"status": true,
"timestamp":1410514902,
"api":{
"version":40103
},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "70c5f522-aaab-4c93-a180-a442a0da9c2a"
}
},
"data":{
"groups": {
"total": 1,
"list": [{
"description":"text",
"modified_time":1410414861,
"has_personal_settings":true,
"permissions":{
"inherited_group_id":"20e27d73-d21d-b211-a788-85419c46f0e6",
"list":[{
"value":1,
"right":1,
"name":"Run Dr.Web Scanner for Windows"
}],
"inherited":true,
"inherited_group_name":"Everyone"
},
"parent_group_name":"Tariffs",
"parent_group_id":"994992e8-be71-4d31-a1f5-5b7786262611",
"stations":0,
"created_time":1410414861,
"id":"my_tariff",
"child_groups":0,
"custom_tariff": false,
"name":"my_tariff",
"grace_period":{
"inherited":false,
"grace_period":7
},

,
"type":11,
"components":{
"inherited":false,
"list":[{
"status":1,
"name":"Dr.Web Scanner for Windows",
"code":4
}]
}
}]
}
}
}

Field name	Description
id	Tariff group ID
created_time	Group creation time and date in Unix timestamp format
modified_time	Group modification time and date in Unix timestamp format. Is always the same as the created attribute.
name	Tariff group name
description	Tariff group description
parent_id	Parent group ID
parent_name	Parent group name
type	Group type. Is always 11
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
stations	Number of stations in the tariff group
child_groups	Number of child groups
custom_tariff	The value is set to true if the requested tariff group is custom. Otherwise, the value is set to false.

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 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 list array in the permissions contains information about a specific element of rights.

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 grace_period block contains information on grace period of the tariff group.

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
grace_period	Grace period of the tariff group (days)

▪The list array in the component block contains information about a specific component.

Field name

Description

code

Digital code of the component. See the Component codes section.

name

Component name. See the Component codes section.

status

Component status. May take one of the following values:

•2—component must be installed,

•1—component can be installed,

•0—component cannot be installed.