|
Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Station identifier.
This parameter can be defined in the request several times to get installing components lists for several stations at a time.
|
yes
|
Request Example
http://192.168.1.1:9080/api/stations/components.ds?id=30cc7eb2-d11d-b211-b695-b80815e63511
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1401789582" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="1">
<station id="30cc7eb2-d11d-b211-b695-b80815e63511">
<components total="13" inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<component code="4" name="Dr.Web Scanner for Windows" status="1"/>
<component code="14" name="SpIDer Mail for Windows workstations" status="1"/>
<!-- etc. Skipped in documentation -->
<component code="37" name="Dr.Web Agent Scanner for Windows" status="2"/>
<component code="39" name="Dr.Web Agent for UNIX" status="2"/>
</components>
</station>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information on all requested 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 station. The <stations /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
•The <components /> element contains information on all installing components of a specific station. The <components /> element attributes:
Attribute
|
Description
|
total
|
Total number of all components
|
inherited
|
If its value is set to true, then component parameters are inherited from a parent group, and if set to false—then component parameters are configured individually.
|
inherited_group_id
|
ID of a parent group from which component parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which component parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
▫The <component /> element contains information about a specific installing component. The <component /> element attributes:
Attribute
|
Description
|
code
|
Digital code of the component. See the Component codes section
|
name
|
Component name. See the Component codes section
|
status
|
Component status. May take one of the following values:
•2—component must be installed, •1—component can be installed, •0—component cannot be installed. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp":1410514156,
"api":{
"version":40103
},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "70c5f522-aaab-4c93-a180-a442a0da9c2a"}},
"data":{
"total": 1,
"list": [{
"station_id":"if",
"inherited_group_id":"20e27d73-d21d-b211-a788-85419c46f0e6",
"components":[{
"status":1,
"name":"Dr.Web Scanner for Windows",
"code":4
},{
"status":1,"name":"SpIDer Mail for Windows workstations",
"code":14
},{
"status":1,"name":"SpIDer Gate for Windows workstations","code":38}
],
"inherited":true,
"inherited_group_name":"Everyone"}]}}
|
Description of JSON Response Parameters
The data block contains information on 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 stations. Elements in the list array:
Field name
|
Description
|
station_id
|
Station identifier
|
inherited_group_id
|
ID of a parent group from which component parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
inherited
|
If its value is set to true, then component parameters are inherited from a parent group, and if set to false—then component parameters are configured individually.
|
inherited_group_name
|
Name of a parent group from which component parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
•The components array contains information about a specific installing component. Elements in the components array:
Field name
|
Description
|
status
|
Component status. May take one of the following values:
•2—component must be installed, •1—component can be installed, •0—component cannot be installed. |
name
|
Component name. See the Component codes section
|
code
|
Digital code of the component. See the Component codes section
|
|
