|
Request Parameters
Parameter
|
Description
|
Valid values
|
Note
|
Mandatory
|
id
|
Group ID
|
Digits, latin characters, and symbols ‘_’, ’-‘
|
If not set, an ID will be generated automatically
|
no
|
name
|
Group name
|
-
|
|
yes
|
description
|
Group description
|
-
|
|
no
|
components
|
Set of components
|
Bit field. See the Component codes section
|
Sets components that will be available on a client PC.
If this parameter is set, you do not need to set parameters for individual components installation.
|
no
|
component-scanner
|
Individual components
|
0—the component cannot be installed;
1—the component can be installed;
2—the component must be installed.
|
If the components parameter is set, it is used with higher priority.
|
no
|
component-office-control
|
component-spider-guard
|
component-spider-guard-servers
|
component-spider-mail
|
component-spider-gate
|
component-msoutlook-plugin
|
component-firewall
|
component-antispam
|
grace-period
|
Grace period
|
Integer
|
Grace period (days). Available values: 0-90. If number greater than 90 is specified, the maximum available value is used.
|
no
|
parent-group
|
ID of a parent group where a new tariff group will be created
|
|
IDs of existing tariff groups can only be specified in this parameter. Non-tariff group IDs are not allowed.
If parameter is not set, the group selected in the Server settings is used as a parent group.
|
no
|
Request Example
http://192.168.1.1:9080/api/tariffs/add.ds?id=111111&name=11111&description=11111&components=4&grace-period=0
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1408348450" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<group id="d6288ee3-1cfe-4796-a403-a8c5ed06285e"/>
</drweb-avdesk-api>
|
Description of XML Response Parameters
The <group /> element contains information about a created tariff group.
The <group /> element attributes:
Attribute
|
Description
|
id
|
Tariff group ID
|
JSON Response Structure
{
"head": {
"status": true,
"timestamp":1410515348,
"api":{
"version":40103
},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "70c5f522-aaab-4c93-a180-a442a0da9c2a"
}
},
"data": {
"id":"111111"
}
}
|
Description of JSON Response Parameters
The data block contains information about the created tariff group.
The data block elements:
Field name
|
Description
|
id
|
Identifier of created tariff group
|
|
