|
Request Parameters
Parameter
|
Description
|
Mandatory
|
Note
|
server-id
|
Identifier of the Server to which stations are connected
|
no
|
|
group-id
|
Identifier of a group stations of which will be given in the response. Response contains information on all stations of this group (without nesting).
|
no
|
|
page
|
Number of displayed pages
|
no
|
The default value is 1
|
per-page
|
Number of records on one page
|
no
|
The default value is 100
|
state
|
Station state. May take one of the following values:
•online—stations are online, •offline—stations are offline, •activated—stations are activated, •unactivated—stations are not activated, •deinstalled—antivirus software in uninstalled from stations, •expired—stations with expired access to the Server, •blocked—access of stations to the Server is blocked, •new—new stations, antivirus software is not installed, •newbies—newbies, •with_update_errors—stations with errors of antivirus software updates, •deleted—stations are deleted. |
no
|
|
|
The page and per-page parameters operate with the state attribute only.
|
Request Example
http://192.168.1.1:9080/api/stations/list-by-state.ds?page=1&per-page=3&state=newbies
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1392276843" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations><newbies total="3">
<station id="fdaa5c58-08a7-4fa8-a04b-71a1456c76ed" name="DRWEB-E32C88DAD" last_seen_time="1392022240" last_seen_addr="tcp/192.168.1.2:1921" onconnect="0" state="0"/>
<station id="004fcafc-d11d-b211-a3db-f40462c46ebc" name="DRWEB-E32C88DAD" last_seen_time="1392025605" last_seen_addr="tcp/192.168.1.2:1038" onconnect="0" state="0"/>
<station id="40184d94-d11d-b211-9a20-d40dacb7cea6" name="DRWEB-E32C88DAD" last_seen_time="1392095467" last_seen_addr="tcp/192.168.1.2:1189" onconnect="0" state="0"/>
</newbies>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information on all stations with requested state. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations
|
▫The <station /> element contains information on specific station. 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
|
Network address of last connection of a station to the Server
|
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. |
state
|
Station state. May take one of the following values:
• 0—station is offline, • 1—station is online, • 2—access to the Server for a newbie is granted, • 3—access to the Server for a newbie is denied. |
JSON Response Structure
{"head": {
"status": true,
"timestamp":1392278932,
"api":{
"version":40103},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "a509dab1-d423-4059-971a-aa3944a2c48a"}},
"data":{
"pages": {
"total": 1,
"current": 1,
"objects_per_page": 3
},
"stations":{
"newbies": {
"total": 3,
"list": [ {
"id": "fdaa5c58-08a7-4fa8-a04b-71a1456c76ed",
"name": "DRWEB-E32C88DAD", "last_seen_time":1392022240,
"last_seen_addr":"tcp/192.168.10.124:1921" ,
"state": 0, "onconnect": 0
} , {
"id": "004fcafc-d11d-b211-a3db-f40462c46ebc",
"name": "DRWEB-E32C88DAD",
"last_seen_time":1392025605,
"last_seen_addr":"tcp/192.168.10.124:1038" ,
"state": 0,
"onconnect": 0
} , {
"id": "40184d94-d11d-b211-9a20-d40dacb7cea6",
"name": "DRWEB-E32C88DAD",
"last_seen_time":1392095467,
"last_seen_addr":"tcp/192.168.10.124:1189" ,
"state": 0,
"onconnect": 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
|
Total number of pages displayed
|
objects_per_page
|
The number of records on one page
|
•The stations block contains information on all stations with requested state, the nested block name corresponding to the requested state. The station nested blocks elements:
Field name
|
Description
|
total
|
Total number of stations
|
▫The list array contains information on specific stations. 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
|
Network address of last connection of a station to the Server
|
onconnect
|
Action that will be performed on the last 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. |
state
|
Station state. May take one of the following values:
• 0—station is offline, • 1—station is online, • 2—access to the Server for a newbie is granted, • 3—access to the Server for a newbie is denied. |
|
