Vehicle->GetVehiclesInDepot

Last updated
Save as PDF

GetVehiclesInDepot (Vehicle function)

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

XML Request

The GetVehiclesInDepot function takes the following input parameters:

Parameter	Type	Description
DepotId	short	The ID of the depot whose vehicles should be returned

  
<soap:Body>  
  <GetVehiclesInDepot xmlns="http://www.qualcomm.com">  
    <request>  
      <DepotId>short</DepotId>  
    </request>  
  </GetVehiclesInDepot>  
</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	Optional	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>  
  <GetVehiclesInDepotResponse xmlns="http://www.qualcomm.com">  
    <GetVehiclesInDepotResult>  
      <Vehicles>  
        <VehicleInfo>  
          <VehicleID>string</VehicleID>  
          <UA>int</UA>  
        </VehicleInfo>  
        <VehicleInfo>  
          <VehicleID>string</VehicleID>  
          <UA>int</UA>  
        </VehicleInfo>  
      </Vehicles>  
    </GetVehiclesInDepotResult>  
  </GetVehiclesInDepotResponse>  
</soap:Body>