Get Vehicle Parameter Type

Last updated
Save as PDF

getVehicleParameterType

Given a vehicle Id, this web service returns the vehicle's parameter type.

String getVehicleParameterType(AssetIdentifier vehicle) throws WSException

vehicle: An AssetIdentifier containing the SCAC and Id of the vehicle whose parameter type should be returned.

Returns a null string on exceptions; otherwise returns a string that contains the parameter type to which the vehicle belongs.

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
- Performance Monitoring

Required User Permissions
- Can use Performance Monitoring

Sample XML Request

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

<soap:Body>

<getVehicleParameterType>

<vehicle>

<id>A00003</id>

<scac></scac>

</vehicle>

</getVehicleParameterType>

</soap:Body>

Sample XML Response

<soapenv:Body>

<getVehicleParameterTypeResponse>

<vehicleParameterType>TST</vehicleParameterType>

</getVehicleParameterTypeResponse>

</soapenv:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Invalid vehicle id.