Skip to main content
Omnitracs Knowledge Base

Vehicle->GetVehiclesInGroup

GetVehiclesInGroup (Vehicle Function)

Returns a list of VehicleInfo objects, one for each vehicle in the specified group. Each VehicleInfo has the Vehicle ID and UA.

XML Request

The GetVehiclesInGroup function takes the following input parameters:

Parameter Type Description
Group string The name of the group whose vehicles should be returned
  
<soap:Body>  
   <GetVehiclesInGroup xmlns="http://www.qualcomm.com">  
      <request>  
        <Group>string</Group>  
      </request>  
    </GetVehiclesInGroup>  
</soap:Body>  

XML Response

The XML response will have a <Vehicles> tag that contains a list of <VehicleInfo> tags. Each contains the following values:

Parameter Type Optiponal Description
VehicleID string No The vehicle ID. That is also referred to as the tractor ID.
UA int Yes The comm unit serial number. If a vehicle does not have a UA, then this field will not be present for that vehicle
  
<soap:Body>  
<GetVehiclesInGroupResponse xmlns="http://www.qualcomm.com">  
      <GetVehiclesInGroupResult>  
        <Vehicles>  
          <VehicleInfo>  
            <VehicleID>string</VehicleID>  
            <UA>int</UA>  
          </VehicleInfo>  
          <VehicleInfo>  
            <VehicleID>string</VehicleID>  
            <UA>int</UA>  
          </VehicleInfo>  
        </Vehicles>  
      </GetVehiclesInGroupResult>  
    </GetVehiclesInGroupResponse>  
</soap:Body>  
  • Was this article helpful?