Ping Vehicle
pingVehicle
Requests that a vehicle report its current position. This causes an over-the-air request to be transmitted to the vehicle. The vehicle will respond to this request by transmitting a new position report. You must subscribe to position report transactions in order to receive the resulting position report.
void pingVehicle(AssetIdentifier vehicle) throws WSException
- vehicle: A QTWebServices AssetIdentifier that uniquely identifies the vehicle to which a position update request will be transmitted.
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
- Can ping vehicle
- Can see data for all assets OR the vehicle must be in the user's coverage or global group
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.
|
|
Sample XML Response
No response conveys success. If ping did not succeed, an exception would have been thrown.
|
|
Exceptions
002 Required field not specified.
003 Company not authorized for access through integration.
004 User is not authorized.
005 SCAC is required.
006 SCAC is invalid.
007 Vehicle ID is required.
008 Vehicle not found.
009 Previous update is pending.
010 Cannot update position for a vehicle without a device.