Get Counts

Last updated
Save as PDF

getCounts

Given a coverage identifier (optional), this web service returns a Counts object that contains several totals that are important for vehicle management. This web service can be called to determine the total number of vehicles, auxiliary vehicles, covered vehicles, address lists, message groups, drivers, and users that have been manually or automatically setup for the calling company. The total number of covered vehicles is the number of vehicles covered by the calling user when the coverage parameter is blank. When the coverage parameter is specified on the call, covered vehicles is the total number of vehicles in the given coverage id.

Counts getCounts(String coverage) throws WSException

coverage: A coverage id that has been setup to associate users with vehicles. When this parameter is specified, the covered vehicles field in the returned Counts object is equal to the total number of vehicles in the given coverage.

A successful call returns a Counts object.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use QTRACS

Customer integrators are authorized to their own company's data only.

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<getCounts>

<coverage>DRY</coverage>

</getCounts>

</soap:Body>

Sample XML Response

<soapenv:Body>

<getCountsResponse>

<getCountsReturn>

<coveredVehicles>224</coveredVehicles>

<totalAddrList>25</totalAddrList>

<totalAuxVehicles>8</totalAuxVehicles>

<totalMsgGrps>12</totalMsgGrps>

<totalVehicles>596</totalVehicles>

<totalDrivers>16</totalDrivers>

<totalUsers>44</totalUsers>

</getCountsReturn>

</getCountsResponse>

</soapenv:Body>

Exceptions

002 Null value in one of the SQL null indicator fields.
003 Authenticated company not specified.
004 Authenticated user not specified.
005 User is not authorized.
006 Coverage ID not found.
007 Coverage ID is invalid.