|
Request Parameter
Parameter
|
Description
|
Mandatory
|
id
|
Group ID
|
yes
|
Request Example
https://192.168.1.1:9081/api/groups/geo.ds?id=7ec98a70-5c83-11ea-512f-70a167e08535
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1588871306" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="2">
<station id="1003" name="WIN-7-PRO-SP1-X">
<longitude>0</longitude>
<latitude>0</latitude>
<country />
<province />
<city />
<street />
</station>
<station id="1004" name="Test">
<longitude>3222220</longitude>
<latitude>3333330</latitude>
<country>EG</country>
<province>G_region</province>
<city>G_Town</city>
<street>G_avenue</street>
</station>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains location data of all stations in a group specified in the request.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in a response
|
•The <station /> element contains parameters of a specific station.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Station ID
|
name
|
Station name
|
▫Nested elements of the <station /> element contain location data of a station:
Element
|
Description
|
<longitude />
|
Longitude
|
<latitude />
|
Latitude
|
<country />
|
Country
|
<province />
|
Province
|
<city />
|
City
|
<street />
|
Street
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1588871857,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},
"data": {
"total": 2,
"list": [
{"id": "1003",
"latitude": 0,
"longitude": 0,
"name": "WIN-7-PRO-SP1-X"},
{"city": "G_Town",
"country": "EG",
"id": "1004",
"latitude": 3333330,
"longitude": 3222220,
"name": "Test",
"province": "G_region",
"street": "G_avenue"}]}}
|
Description of JSON Response Parameters
The data block contains location data of all stations in a group specified in the request.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
list
|
Array with location data of each station in a specified group
|
•Each object in the list array contains location data of a specific station in the specified group.
Elements in the list array:
Field name
|
Description
|
city
|
City
|
country
|
Country
|
id
|
Station ID
|
latitude
|
Latitude
|
longitude
|
Longitude
|
name
|
Station name
|
province
|
Province
|
street
|
Street
|
|