2.1. General Structure of Response Documents

 Top  Previous  Next

To receive a response in the XML format, send a request in the following format:

http://<host>:9080/api/<object>/<script>.ds?<parameters>

or

https://<host>:9081/api/<object>/<script>.ds?<parameters>

where:

<host>—IP address or DNS name of a computer with the Server installed

<object>—managing object: station, group, Server, administrator

available scripts and their parameters are described below

As a response, you receive an xml document with the following content:

<drweb-avdesk-api api_version="4.1.3" timestamp="1392276843" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
...
</drweb-avdesk-api>

Attributes of the <drweb-avdesk-api /> root element

Attribute

Description

api_version

Current Web API version

local_timestamp

Local time of server. Unix timestamp

timestamp

GMT time of server Unix timestamp

server

Server domain name or IP address

srv_version

Full version of Dr.Web AV-Desk

status

Request status: true—a request has been processed successfully, false—an error occurred, a request has not been processed

If an error occurred during operation(status=’false’), then the <error> element containing an error text and code will be included in the XML body. An error is described in the <message> element while an error code is in the <errno> element.

<drweb-avdesk-api api_version="4.1.3" timestamp="1403850629" server="192.168.1.1" srv_version="10.01.0.201707130" status="false">
<error>
<errno>36</errno>
<message>
Unable to remove group '411dac63-2a3e-4ce8-af4f-1fbeb94242ef': You cannot remove the system group
</message>
</error>
</drweb-avdesk-api>

Error codes are given in the Returned error codes section.

Date and time in all elements of Web API 4.1.3 scripts are returned in the Unix timestamp format.