Get Vehicle Management Guide

Last updated
Save as PDF

getVehicleManagementGroup

Given a vehicle Id, this web service returns the vehicle's management group. The management group is presently a Performance Monitoring construct only.

String getVehicleManagementGroup(AssetIdentifier vehicle) throws WSException

vehicle: An AssetIdentifier containing the SCAC and Id of the vehicle whose management group should be returned.

Returns a null string on exceptions; otherwise returns a string that contains the identifier of the management group to which the vehicle belongs. Blanks are valid and indicate that the vehicle is not part of a management group.

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>

<getVehicleManagementGroup>

<vehicle>

<id>A00003</id>

<scac></scac>

</vehicle>

</getVehicleManagementGroup>

</soap:Body>

Sample XML Response

<soapenv:Body>

<getVehicleManagementGroupResponse>

<vehicleManagementGroup>SOUTHEAST</vehicleManagementGroup>

</getVehicleManagementGroupResponse>

</soapenv:Body>

Exceptions

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