|
Request Parameter
Parameter
|
Description
|
Mandatory
|
id
|
Station ID.
This parameter can be repeated any number of times per request to obtain information about products on multiple stations at a time.
|
yes
|
Request Example
https://192.168.1.1:9081/api/stations/products.ds?id=1002
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1587645254" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="1">
<station id="1002">
<products total="4">
<product code="10-drwbases" modified_time="1587620547" revision="13020200416235234" state_code="S" state="Normal state">Dr.Web virus databases</product>
<product code="10-drwspamdb" modified_time="1587620547" revision="13020200416220812" state_code="S" state="Normal state">Dr.Web Anti-spam databases</product>
<product code="20-drwagent" modified_time="1587620547" revision="13020200415153408" state_code="S" state="Normal state">Dr.Web Agent for Windows</product>
</products>
</station>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains information about all products on stations specified in the request.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in a response
|
•The <station /> element contains information about a specific station.
The <station /> element attribute:
Attribute
|
Description
|
id
|
Station ID
|
▫The <products /> element contains information about all products on a station.
The <products /> element attribute:
Attribute
|
Description
|
total
|
Total number of products on a station
|
▪The <product /> element contains information about a specific product.
The <product /> element attributes:
Attribute
|
Description
|
code
|
Product code
|
modified_time
|
Date of the last revision update
|
revision
|
Revision number
|
state_code
|
Update state code:
•D—update is delayed,
•F—update error,
•S—the product was updated successfully. |
state
|
Update state:
•Delayed—update is delayed,
•Update failed—update error,
•Normal state—the product was updated successfully. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1587647090,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "6d8f5aa0-850a-11ea-4c3c-c8efa441e4dd"}}
"data": {
"total": 1,
"list": [
{"products": {
"10-drwbases": {
"modified_time": "1587620547",
"name": "Dr.Web virus databases",
"revision": 13020200416235234,
"state": "Normal state",
"state_code": "S"},
"10-drwspamdb": {
"modified_time": "1587620547",
"name": "Dr.Web Anti-spam databases",
"revision": 13020200416220812,
"state": "Normal state",
"state_code": "S"},
"20-drwagent": {
"modified_time": "1587620547",
"name": "Dr.Web Agent for Windows",
"revision": 13020200415153408,
"state": "Normal state",
"state_code": "S"}},
"station_id": "1002",
"total": 4}]}}
|
Description of JSON Response Parameters
The data block contains information about all products on stations specified in the request.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
list
|
Array with information about products for every station
|
•Every object in the list array contains information about products on a specific station.
Elements in the list array:
Field name
|
Description
|
products
|
Block of parameters for each product on a station
|
station_id
|
Station ID
|
total
|
Total number of products on a station
|
▫The products block consists of nested blocks.
▪Every nested block contains parameters of a specific product. Nested block name corresponds with a product code in the repository.
Nested block elements in the products block:
Field name
|
Description
|
modified_time
|
Date of the last revision update
|
name
|
Product name
|
revision
|
Revision number
|
state
|
Update state:
•Delayed—update is delayed,
•Update failed—update error,
•Normal—the product was updated successfully. |
state_code
|
Update state code:
•D—update is delayed,
•F—update error,
•S—the product was updated successfully. |
|