Export Vehicle Membership

Last updated
Save as PDF

exportVehicleMembership

Given a vehicle identifier (optional) and a number of vehicles to return, this web service returns a list of Vehicle Membership Data objects in alphabetical order by the Vehicle ID.

VehicleMembershipData[] exportVehicleMembership(string companyId, AssetIdentifier vehicle, int numOfVehicles) throws WSException

companyId: (optional) A string, maximum length 10, specifying the unique company identifier.
NOTE: If no companyId is specified, the company of the authorized user making the call will be used.
vehicle: A QTWebServices AssetIdentifier containing the SCAC and ID. The returned list will begin after (alphabetically) the vehicle that is specified on the call. When the SCAC and ID inside the AssetIdentier are blank, the list will begin with the first vehicle in alphabetical order by the Vehicle ID.
numOfVehicles: The number of vehicles to return in the list. The allowed range is 1 to 32766.

Return Data Notes:
- Returns a null string on exceptions; otherwise returns an array of VehicleMembershipData objects.
- Each VehicleMembershipData object contains up to 15 global groups to which the vehicle is a member. If the vehicle is a member of more than 15 global groups, only the first 15 are included. To receive the full list of global groups to which a vehicle is a member, call the Get Group Membership web service.

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>

<exportVehicleMembership>

<companyId>ABCTRUCKS</companyId>

<vehicle>

<id>VEHICLE1</id>

<scac></scac>

</vehicle>

<numOfVehicles xmlns="">2</numOfVehicles>

</exportVehicleMembership>

</soap:Body>

Sample XML Response

<soapenv:Body>

<exportVehicleMembershipResponse>

<exportVehicleMembershipReturn>

<VehicleMembershipData>

<id>VEHICLE2</id>

<ua>0012421654</ua>

<vin>1G6CD5183H4333111</vin>

<coverage>COVERAGE12</coverage>

<vmg>

<string>GROUP1</string>

<string>GROUP2</string>

</vmg>

<gg>

<string>GlobalGroup1</string>

<string>GlobalGroup2</string>

</gg>

</VehicleMembershipData>

<VehicleMembershipData>

<id>VEHICLE3</id>

<ua>0012421653</ua>

<vin>1G6CD5183H4333113</vin>

<coverage>COVERAGE12</coverage>

<vmg>

<string>GROUP1</string>

<string>GROUP2</string>

</vmg>

<gg>

<string>GlobalGroup1</string>

<string>GlobalGroup2</string>

</gg>

</VehicleMembershipData>

</exportVehicleMembershipReturn>

</exportVehicleMembershipResponse>

</soapenv:Body>

Exceptions

002 Required field not specified.
003 Company not authorized for integration.
004 User is not authorized.
005 Invalid company id.
006 SCAC is invalid.
007 Vehicle id is invalid.
008 No vehicles found.
009 Invalid number of records specified.