|
Request Parameter
Parameter
|
Description
|
Mandatory
|
id
|
Station ID.
Can be repeated any number of times per request to obtain information about multiple stations at a time.
|
yes
|
Request Example
https://192.168.1.1:9081/api/stations/newbies-info.ds?id=1e98b5e0-5166-11ea-410d-fc78713e8b1f
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1582030264" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="1">
<station id="1e98b5e0-5166-11ea-410d-fc78713e8b1f" name="win7-pro-x86-ru" created="1581930965" parent_id="20e27d73-d21d-b211-a788-85419c46f0e6" parent_name="Everyone" state="0">
<os code="33753095">Windows 7 Professional x86</os>
<server>aa5520b0-4e4f-11ea-6061-94d96b90100f</server>
<address>tcp://192.168.1.1:57516</address>
</station>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains information about newbie stations.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in a response
|
•The <station /> element contains parameters of a specific newbie station.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Station ID
|
name
|
Station name
|
created
|
Date when station account was created on the Dr.Web Server
|
parent_id
|
Parent group ID
|
parent_name
|
Parent group name
|
state
|
Current state of a station (see Appendix D. Returned Station State Codes)
|
▫The <os /> element contains information about the operating system currently installed on the station.
The <os /> element attribute:
Attribute
|
Description
|
code
|
Operating system code
|
The <os /> element value is an operating system name.
▫The <server /> element value is ID of the Dr.Web Server a station requests connection to.
▫The <address /> element value is a network address from which a station accessed the Dr.Web Server the last time.
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1582030521,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},
"data": {
"total": 1,
"list": [{
"address": "tcp://192.168.1.1:40566",
"created_time": 1581930965,
"id": "1e98b5e0-5166-11ea-410d-fc78713e8b1f",
"name": "win7-pro-x86-ru",
"onconnect": 0,
"os_code": 33753095,
"onconnect": 0,
"os_name": "Windows 7 Professional x86",
"parent_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"parent_name": "Everyone",
"server": "aa5520b0-4e4f-11ea-6061-94d96b90100f",
"state": 0}]}}
|
Description of JSON Response Parameters
The data block contains information about all newbie stations.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
list
|
Array with information about every newbie station
|
•Every object in the list array contains information about a specific newbie station.
Elements in the list array:
Field name
|
Description
|
address
|
Network address from which a station accessed the Dr.Web Server the last time
|
created_time
|
Date when a station account was created on the Dr.Web Server
|
id
|
Station ID
|
name
|
Station name
|
onconnect
|
Action to be performed when a station connects to the Dr.Web Server next time:
0—perform nothing,
1—access to the Dr.Web Server for a newbie will be denied,
2—access to the Dr.Web Server for a newbie will be granted.
|
os_code
|
Operating system code
|
os_name
|
Operating system name
|
parent_id
|
Parent group ID
|
parent_name
|
Parent group name
|
server
|
ID of the Dr.Web Server a station requests connection to
|
state
|
Current state of a station (see Appendix D. Returned Station State Codes)
|
|