|
Request Parameters
Parameter
|
Description
|
Mandatory
|
parent-group
|
Parent tariff group identifier.
Response contains information on all child groups of a parent tariff group (without nesting).
If parameter is not set, response contains information on all tariff groups of the Tariffs group level.
|
no
|
Request Example
http://192.168.1.1:9080/api/tariffs/list.ds
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="12">
<group id="994992e8-be71-4d31-a1f5-5b7786262611" name="Tariffs" child-groups="0" stations="0" />
<group id="2888b7ff-3625-465e-bcb8-957de17f6458" name="AV" child-groups="0" stations="0" />
<group id="ebe76ffc-69e1-4757-b2b3-41506832bc9b" name="AV+AS" child-groups="0" stations="0" />
<group id="a8f0c2f7-5689-4105-8e7b-e5df0790d0a8" name="AV+PC" child-groups="0" stations="0" />
<group id="91644cc3-1dc1-42dc-a41e-5ea001f5538d" name="AV+AS+PC" child-groups="0" stations="0" />
<group id="01fe9e60-6570-11de-b827-0002a5d5c51b" name="AV+AS+PC+SRV" child-groups="0" stations="0" />
<group id="0ea388b5-831c-48a9-8c67-c29d949aea90" name="TestRate" child-groups="0" stations="0" />
<group id="a5dc6a7f-adb3-43d7-9f91-84dc4466e8b8" name="TestRate" child-groups="0" stations="0" />
<group id="c1cb9043-15b7-4f68-ae37-4d9e230b1158" name="TestRate" child-groups="0" stations="0" />
<group id="c9ba2fed-da68-458e-915f-59136932246a" name="TestRate" child-groups="0" stations="0" />
<group id="4d7ed61a-1ed1-4a3a-aea7-02edc20febe8" name="MyTariff" child-groups="0" stations="0" />
<group id="93938929-7c42-4567-ae63-84ba4096902b" name="MyTariff3" child-groups="0" stations="0" />
</groups>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <groups /> element contains a list of all tariff groups. The <groups /> element attributes:
Attribute
|
Description
|
total
|
Total number of tariff groups
|
▫The <group /> element contains information about a specific tariff group.
Attribute
|
Description
|
id
|
Tariff group ID
|
name
|
Tariff group name
|
stations
|
Number of stations in the group
|
child-groups
|
Number of child groups
|
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",
"parent_id":"320bb310-7144-4e48-9772-ad8578a150f4",
"parent_name":"New1",
"child_groups":0,
"stations":0
} , {
"id":"3",
"name":"New3",
"parent_id":"320bb310-7144-4e48-9772-ad8578a150f4",
"parent_name":"New1",
"child_groups":0,
"stations":0
}
] }
} }
|
Description of JSON Response Parameters
•The groups block contains information about all requested tariff groups. The groups block elements:
Field name
|
Description
|
total
|
Total number of tariff groups
|
▫The list array contains information about specific tariff groups. Elements in the list array:
Field name
|
Description
|
id
|
Tariff group ID
|
name
|
Tariff group name
|
stations
|
Number of stations in the group
|
child-groups
|
Number of child groups
|
|
