Skip to main content
Omnitracs Knowledge Base

Disable Vehicle for SensorTRACS

disableVehicleForST

Removes a vehicle from active list of Performance Monitoring vehicles given an asset identifier. Vehicle group membership (from both adhoc and management groups) is terminated as well. Performance history is not deleted when a vehicle is disabled, nor is historical key performance measurement data removed.

void disableVehicleForST(AssetIdentifier vehicle) throws WSException

  • vehicle: An AssetIdentifier containing the SCAC and ID of the vehicle to be disabled for SensorTRACS.

 

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 Performance Monitoring
- Can maintain vehicles and drivers

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>

   <disableVehicleForST>

      <vehicle>

         <id>TRUCK10</id>

         <scac></scac>

      </vehicle>

   </disableVehicleForST>

</soap:Body>

 

Sample XML Response

 

No response conveys success. If delete did not succeed, an exception would have been thrown.

<soapenv:Body>

   <disableVehicleForSTResponse/>

</soapenv:Body>

 

Exceptions

 

001 Unknown Error.
002 Required field not specified.
003 Company not authorized for access through integration.
004 User is not authorized.
005 Vehicle invalid.

  • Was this article helpful?