Request Parameters
Parameter
|
Description
|
Note
|
Mandatory
|
id
|
Subscription group identifier
|
The parameter can be defined in the request as many times as you like to delete multiple groups at a time
|
yes
|
new-rate
|
Only tariff group identifier may be specified in this parameter
|
If parameter is specified, all stations from deleting tariff group will be moved to the specified group
|
no
|
If deleting tariff group is primary for any stations, for these stations, a tariff group from the new-rate parameter will be set as primary.
|
You cannot delete a tariff group if:
1.This tariff group is basic (preinstalled) group. 2.Tariff group contains or be able to contain at least one station. |
Request example
https://host:9081/api/3.0/tariffs/delete.ds?id=7919712c-cfeb-4b88-8cb8-ac00c678991b
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" local_timestamp="1293201658" server="192.168.1.1" srv_version="10.01.0.201707130" status="true" timestamp="1293180058">
<groups total="1">
<group id="7919712c-cfeb-4b88-8cb8-ac00c678991b"/>
</groups>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <groups /> element contains information about all deleted tariff groups. The <groups /> element attributes:
Attribute
|
Description
|
total
|
Total number of groups deleted
|
▫The <group /> element contains information about a deleted tariff group. The <group /> element attributes:
Attribute
|
Description
|
id
|
Subscription group ID
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1395735077,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "1023dcd7-d11d-b211-896d-8804c0842edb"
}
},
"data": {
"groups": {
"total": 2,
"list": [
{
"id": "7919712c-cfeb-4b88-8cb8-ac00c678991b"
},
{
"id": "1234567c-cfeb-4b88-8cb8-ac00c678991b"
}
]
}
}
}
|
Description of JSON Response Parameters
•The groups block contains information about all deleted tariff groups. The groups block elements:
Field name
|
Description
|
total
|
Total number of tariff groups
|
•The list array contains information about specific deleted tariff groups. Elements in the list array:
Field name
|
Description
|
id
|
Identifier of deleted tariff group
|
|