E1. Get Station Information

 Top  Previous  Next

Request

http://avdesk.isp.net:9080/api/2.0/get-customer-info.ds

Request Parameters

Parameter

Description

Obligatory

Default value

id

If id is not specified, information about all groups will be returned.

no

-

group-id

Group identifier.

no

-

from = YYYYMMDD

or

from = YYYYMMDDHHmmss

Initial date for which the statistics are selected

no

00000000000000000

till = YYYYMMDD

or

till = YYYYMMDDHHmmss

Final date for which statistics are selected

no

9999311223599999

statistics

Client statistics. Parameter can possess one of the following values:

•all—all statistics for time period set by from and till parameters

•main—only basic statistics

•none—no statistics

•viruses—only TOP viruses.

no

viruses

vircount

Defines number of viruses in TOP returned if statistics=all and statistics=viruses. If statistics=none, then vircount is ignored.

no

10

If id and group_id parameters are not specified, information about all clients (stations) will be returned.

If the id parameter is not specified, but the group_id parameter is specified, all information about the clients (stations) from this group will be returned.

Calling the script without id and group_id parameters gives additional workload on the database.

Reply XML

<avdesk-xml-api api="2.2.0" timestamp="20160121114254999" server="10.4.0.191" oper="get-customer-info" version="10.000.1.201510090" rc="true">
  <customers total="Total number of clients">

    <customer>

      <id>Client (station) identifier</id>

      <name>Station name</name>

      <createdtime>Date and time of creation</createdtime>

      <modifiedtime>Date and time of last modification</modifiedtime>

      <graceperiod>Grace period (yes, no)</graceperiod>

      <group id="Group identifier">Group name</group>

      <password>Password</password>

      <url>Link for Agent download</url>

      <tariff id="Tariff identifier">Tariff name</group>

      <expires>Expiration of service date</expires>

      <blocking>

          <begin>Start of blocking period</begin>

          <end>End of blocking period</end>

      </blocking>

      <lastseenfrom>Last connection of Agent from this IP</lastseenfrom>

      <department>Department</department>

      <description>Client (station) description</description>

      <country>Country</country>

      <street>Street</street>

      <room>Room</room>

      <city>City</city>

      <floor>Floor</floor>

      <longitude>Longitude</longitude>

      <latitude>Latitude</latitude>

      <organization>Organization</organization>

      <province>Province</province>

      <deinstalled>Agent is uninstalled? (yes or no)</deinstalled>

      <online>Agent is online now? (yes, no)</online>

      <activated>Agent is activated? (yes, no)</activated>

      <statistics from="Start of defined period" till="End of defined period">

      <cured>Count of cured objects</cured>

      <deleted>Count of deleted objects</deleted>

      <moved>Count of moved objects</moved>

      <infected>Count of infected objects</infected>

      <errors>Count of scan errors</errors>

      <renamed>Count of renamed objects</renamed>

      <scanned>Count of scanned objects</scanned>

      <locked>Count of blocked objects</locked>

      <size>Total size of checked objects in bytes</size>

      <viruses top="Count of viruses returned in TOP">

            <virus count="Number of virus occurrence">Virus name</virus>

            <!-- etc. Skipped in documentation -->

        </viruses>

      </statistics>

  </customer>

  <customer>

  <!-- etc. Skipped in documentation -->

  </customer>

</customers>

</avdesk-xml-api>