|
Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Group identifier
|
yes
|
Request Example
http://192.168.1.1:9080/api/groups/geo.ds?id=30cc7eb2-d11d-b211-b695-b80815e63511
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1410165025" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="9">
<station id="999" name="999">
<longitude>0</longitude>
<latitude>0</latitude>
<country></country>
<province/>
<city/>
<street/>
</station>
<station id="if" name="998">
<!-- etc. Skipped in documentation -->
</station>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information about all stations. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations
|
▫The <station /> element contains information about a specific station. The <station /> element attributes:
Attribute
|
Description
|
id
|
Station ID
|
name
|
Station name
|
Additional elements with station information
Element
|
Description
|
<country>
|
Country
|
<street>
|
Street
|
<city>
|
City
|
<province>
|
Province
|
<longitude>
|
Longitude
|
<latitude>
|
Latitude
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp":1409218738,
"api":{
"version":40103
},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "8e6b1b9d-8952-4547-9d10-25343b6f609d" }},
"data":{
"total": 1,
"list": [{
"longitude":30000000,
"street":"",
"name":"93893af8-b559-4a5f-8bcf-10b90abfc6c4",
"country":"",
"id":"93893af8-b559-4a5f-8bcf-10b90abfc6c4",
"latitude":40000000,
"city":"",
"province":""
}]
}
}
|
Description of JSON Response Parameters
The data block contains information on all stations.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations information on which the replay contains
|
•The list array contains information about specific stations of a requested group. Elements in the list array:
Field name
|
Description
|
longitude
|
Longitude
|
latitude
|
Latitude
|
name
|
Station name
|
id
|
Station identifier
|
country
|
Country
|
province
|
Province
|
city
|
City
|
street
|
Street
|
|
