Search for Stations and Groups

Request Parameters

Parameter

Description

Mandatory

groups

Search by groups.

Valid values: yes | no. By default: yes.

query

Search string

The script searches for matches in the identifier, name and description string of an object and in the identifiers of users.

yes

stations

Search by stations

Valid values: yes | no. By default: no.

Request Example

https://192.168.1.1:9081/api/server/search.ds?query=1&groups=yes&stations=yes

XML and JSON response structure examples are described below.

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1582030253" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<groups total="1">
<group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone" description="All stations" parent_id="" parent_name="" child_groups="0" stations="2"/>

</groups>

Description of XML Response Parameters

•The <groups /> element contains information about all groups matching the request.

The <groups /> element attribute:

Attribute	Description
total	Total number of groups in a response

▫The <group /> element contains parameters of a specific group.

The <group /> element attributes:

Attribute	Description
id	Group ID
name	Group name
description	Description string
parent_id	Parent group ID
parent_name	Parent group name
child_groups	Number of child groups
stations	Number of stations included into this group

•The <stations /> element contains information about all stations matching 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
parent_id	Identifier of a primary group
parent_name	Primary group name
description	Description string
last_seen_time	Time of a last connection of a station to the Dr.Web Server
last_seen_addr	Address from which the station connected to the Dr.Web Server at the last time

JSON Response Structure

{ "head": {
"status": true,

"timestamp": 1582030510,

"api": {
"version": 40300,
"versionString": 4.3.0},

"server": {
"name": "192.168.1.1",

"version": "13.00.0.202005090",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},

"data": {
"groups": {
"total": 1,

"list": [
{"id": "20e27d73-d21d-b211-a788-85419c46f0e6",

"name": "Everyone",

"parent_id": null,

"parent_name": null,

"child_groups": 0,

"stations": 2,
"description": "All stations"}]},

"stations": {
"total": 2,

"list": [
{"id": "Station1",

"name": "Station1",

"parent_id": "20e27d73-d21d-b211-a788-85419c46f0e6",

"parent_name": "Everyone",

"description": "Station 01",,

"last_seen_at": 0,
"last_seen_addr": null}

{"id": "2091ada3-ed5e-e611-3392-f0b9022a5484",
"name": "WIN-7-PRO-SP1-X",

"parent_id": "20e27d73-d21d-b211-a788-85419c46f0e6",

"parent_name": "Everyone",

"description": null,

"last_seen_at": 1489567785,
"last_seen_addr": "tcp://192.168.233.131:49285"}]}}}

Description of JSON Response Parameters

•The groups block contains information about all groups matching the request.

The groups block elements:

Field name	Description
total	Total number of groups in a response
list	Array of parameters for each group

▫Each object of the list array contains parameters of a specific group.

Elements in the list array:

Field name	Description
id	Group ID
name	Group name
parent_id	Parent group ID
parent_name	Parent group name
child_groups	Number of child groups
stations	Number of stations included into this group
description	Description string

•The stations block contains information about all stations matching the request.

The stations block elements:

Field name	Description
total	Total number of stations in a response
list	Array of parameters for each group

▫Each object of the list array contains parameters of a specific station.

Elements in the list array:

Field name	Description
id	Station ID
name	Station name
parent_id	Identifier of a primary group
parent_name	Primary group name
description	Description string
last_seen_at	Time of a last connection of a station to the Dr.Web Server
last_seen_addr	Address from which the station connected to the Dr.Web Server at the last time