Skip to main content
Omnitracs Knowledge Base

Get Vehicle ID

 

getVehicleID

Given the unit address of a mobile communications terminal (MCT), a mobile computing platform (MCP), or an IVG (Intelligent Vehicle Gateway), returns the vehicle identifier of the vehicle to which the mobile device is currently assigned.

AssetIdentifier getVehicleID(String ua) throws WSException

  • ua: A string containing a valid unit address. The unit address is a numeric value of up to 10 digits.

Returns a QTWebServices AssetIdentifier containing the SCAC and ID of the vehicle.

 

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>

    <getVehicleID>

        <ua>010912572</ua>

    </getVehicleID>

</soap:Body>

 

Sample XML Response

 

<soapenv:Body>

    <getVehicleIDResponse>

        <getVehicleIDReturn>

            <id>OAKSTMCT</id>

            <scac></scac>

        </getVehicleIDReturn>

    </getVehicleIDResponse>

</soapenv:Body>

 

Exceptions

 

002 Required field not specified.
003 Company not authorized for access through integration.
004 User is not authorized.
007 A mobile terminal unit address is required.
008 A vehicle with the specified unit address could not be found.
009 Cannot look up the ID for a vehicle without a device.

  • Was this article helpful?