|
Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Station identifier.
This parameter can be defined in the request several times to get information on a several stations at a time.
|
yes
|
Request Example
http://192.168.1.1:9080/api/stations/newbies-info.ds?id=6c4a7a05-eb66-4dae-aef2-6a492c7a4c8c
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1397803490" server="192.168.1.1" srv_version="10.00.0.201404120" status="true">
<stations total="1">
<station id="6c4a7a05-eb66-4dae-aef2-6a492c7a4c8c" name="ANTON16" created="1397737485" parent_id="" parent_name="" state="2">
<rate id="91644cc3-1dc1-42dc-a41e-5ea001f5538d">Dr.Web Premium</rate>
<os code="35851271">Windows 8.1 Pro x64</os>
<server>17a536bd-c6e5-8b37-c0b9-414b8bb7aa75</server>
<address>tcp://192.168.1.1:1363</address>
<admin address="tcp://192.168.1.1:3564">test</admin>
</station>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information on newbies stations. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations information on which the replay contains
|
▫The <station /> element contains information on a specific newbie station. The <station /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
name
|
Station name
|
created
|
Date of account creation at the Server
|
parent_id
|
Parent group identifier
|
parent_name
|
Parent group name
|
state
|
The current state of the station. (See Returned station state codes.)
|
▫The <os /> element contains information on operating system that is installed on a station. The <os /> element attributes:
Attribute
|
Description
|
code
|
Operation system code
|
The <os /> element value is an operating system name.
▫The <server /> element value is identifier of Server to which the station requests a connection. ▫The <address /> element value is a network address from which the station accessed the Server at the last time. ▫The <admin /> element contains information on the administrator of Server, to which the station requests a connection. The <admin /> element attributes:
Attribute
|
Description
|
address
|
Network address from which the administrator connected to the Control Center at the last time
|
The <address /> element value is a name of the administrator of Server, to which the station requests a connection.
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1397802847,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "17a536bd-c6e5-8b37-c0b9-414b8bb7aa75"}},
"data": {
"total": 1,
"list": [
{
"tariff_name":"Dr.Web Premium",
"created_time":1453130709,
"os_name":"Linux",
"id":"1a299c6c-5b5c-4089-a72b-3044752d52b7",
"parent_name":"Everyone",
"admin":"admin",
"parent_id":"20e27d73-d21d-b211-a788-85419c46f0e6",
"state":0,
"admin_address":"tcp://192.168.1.1:42448",
"name":"elena.i.drweb.ru",
"address":"tcp://192.168.1.1:40566",
"tariff_id":"91644cc3-1dc1-42dc-a41e-5ea001f5538d",
"os_code":16842752,
"server":"257f112d-ab07-4d17-ae01-f37b6b135fab",
"onconnect":2}]}}
|
Description of JSON Response Parameters
The data block contains information on all newbies stations.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations information on which the replay contains
|
•The list array contains information on specific newbies stations. Elements in the list array:
Field name
|
Description
|
id
|
Station identifier
|
name
|
Station name
|
created_time
|
Date of account creation at the Server
|
os_name
|
Operation system name
|
state
|
The current state of the station. (See Returned station state codes.)
|
admin_address
|
Network address from which the administrator connected to the Control Center at the last time.
|
address
|
Network address from which the station accessed the Server at the last time
|
os_code
|
Operation system code
|
server
|
Identifier of Server to which the station requests a connection
|
onconnect
|
Action that will be performed on the next connection of a station to the Server:
•0—perform nothing, •1—access to the Server for a newbie will be denied, •2—access to the Server for a newbie will be granted. |
admin
|
Name of the administrator of Server to which the station requests a connection
|
|
