|
Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Group identifier.
Response contains information on all stations of this group (without nesting).
Information on stations of the Operating system, Status, or Ungrouped system groups can be provided in the same way.
|
yes
|
server-id
|
Server identifier from which the information is requested
|
no
|
page
|
The page number in paged view (may be used to display information about the large number of stations)
|
no
|
per-page
|
Number of stations per one page in paged view (may be used to display information about the large number of stations)
|
no
|
Request Example
http://192.168.1.1:9080/api/groups/stations_list.ds?id=1
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1392968284" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="3">
<station id="203fe068-d21d-b211-ac5b-840701ce1bdd" name="203fe068-d21d-b211-ac5b-840701ce1bdd" last_seen_time="0" last_seen_addr="" state="0"/>
<station id="30fa7468-d21d-b211-ac55-840701ce1bdd" name="30fa7468-d21d-b211-ac55-840701ce1bdd" last_seen_time="0" last_seen_addr="" state="0"/>
<station id="50b63369-d21d-b211-ac61-840701ce1bdd" name="50b63369-d21d-b211-ac61-840701ce1bdd" last_seen_time="0" last_seen_addr="" state="0"/>
</stations></drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information on stations included to the specified group. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations that are included to the specified group
|
▫The <station /> element contains information on specific stations of specified group. The <station /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
name
|
Station name
|
last_seen_time
|
Time of last connection to the Server
|
last_seen_addr
|
Address from which the stations connected to the Server at last time
|
state
|
The current state of the station. (See Returned station state codes.)
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1395731278,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "1023dcd7-d11d-b211-896d-8804c0842edb"
}
},
"data": {
"pages": {
"total": 1,
"current": 1,
"objects_per_page": 100
},
"stations": {
"total": 3,
"list": [
{
"id": "203fe068-d21d-b211-ac5b-840701ce1bdd",
"name": "203fe068-d21d-b211-ac5b-840701ce1bdd",
"last_seen_time": 0,
"last_seen_addr": null,
"state": 0
},
{
"id": "30fa7468-d21d-b211-ac55-840701ce1bdd",
"name": "30fa7468-d21d-b211-ac55-840701ce1bdd",
"last_seen_time": 0,
"last_seen_addr": null,
"state": 0
},
{
"id": "50b63369-d21d-b211-ac61-840701ce1bdd",
"name": "50b63369-d21d-b211-ac61-840701ce1bdd",
"last_seen_time": 0,
"last_seen_addr": null,
"state": 0
}
]
}
} }
|
Description of JSON Response Parameters
•The pages block contains information on the number of displayed objects. The pages block elements:
Field name
|
Description
|
total
|
Total number of pages
|
current
|
Number of the current page
|
objects_per_page
|
The number of records on one page
|
•The stations block contains information on all stations of a requested group. The stations block elements:
Field name
|
Description
|
total
|
Total number of stations that are included to the specified group
|
▫The list array contains information on specific stations of specified group. Elements in the list array:
Field name
|
Description
|
id
|
Station identifier
|
name
|
Station name
|
last_seen_time
|
Time of last connection to the Server
|
last_seen_addr
|
Address from which the stations connected to the Server at last time
|
state
|
The current state of the station. (See Returned station state codes.)
|
|
