Get Vehicle Availability Response Structure
Use the left navigation of this guide to view detailed descriptions for each element and attribute used in a GetVehAvail response.
GetVehAvail returns car rental locations based on search criteria provided in the request. The response includes the vehicle (car type) and the rates for those vehicles at specific locations.
Many mandatory and optional items can be in the eesponse:
Mandatory Elements Returned
- Pickup location
- Return location
- Pickup date/time
- Return date/time
- Length of rental days/hours
- Car supplier
- Car type
- Rate code
- Base rate amount
- Base rate plan
- Base rate mileage amount
- Base rate mileage charge
- Total price amount
- Deposit/prepay indicator
- Complete address of location
- Latitude and longitude if available
- Distance and direction of location from input (if Geo)
Optional Elements Returned
- Car types legal occupancy (number of seatbelts)
- Car types bag information (number of small or large bags)
- Car extra (special equipment) code
- Car extra rate plan
- Car extra base rate amount
- Commission indicator percentage
- Rate assured indicator
- Extra day rate
- Extra day mileage amount
- Extra hour rate
- Extra hour mileage amount
- Guarantee/prepay cancel elements
Additional Vehicle Location Policy Information
- Location name
- Rental counter location if an airport location was requested
- Complete physical address
- Geo Location - latitude/longitude (if available)
- Hours of operation for date of pickup
- Repeat of details for drop-off / return location and date
Maximum Response Structure
<GetVehAvailRS>
<VehAvailInfos PickUpDate="2018-12-10" PickUpTime="0730" RentalDays="5" RentalHours="0" ReturnDate="2018-12-15"
ReturnTime="0930">
<VehAvailInfo>
<Vendor Code="TR" Logo="http://vcmp.sgdcelab.sabre.com/image/.....png "Name="TESTRENT"/>
<PickUpLocation Distance="W" Distance="3.94" LocationCode="DFW" ExtendedLocationCode="DFW"
Latitude="32.892" Longitude="-97.04" PolicyRef="TRDFWDFW"/>
<ReturnLocation Distance="NA" ExtendedLocationCode="HOU" LocationCode="HOU" PolicyRef="TRHOUHOU"/>
<VehRentalRate AvailabilityStatus="S" Category="G" GuaranteeInd="G" PriceChangeIndicator="true" RateCode="2L"
RateKey="lotsofencrypteddata" SupplierCurrency="true" RatePlanReturned="W" RatePlanChangeIndicator="true"
RateAssured="*" SellGuaranteeReq="G" PrepayDeposit="P" >
<Vehicle VehType="MBMN">
<SeatBeltsAndBagsInfo>
<SeatBelts Quantity="4"/>
<BagsInfo>
<Bags Size="Large" Quantity="0"/>
<Bags Size="Small" Quantity="2"/>
<BagsInfo>
<SeatBeltsAndBagsInfo>
<Vehicle>
<VehicleCharges>
<VehicleCharge CurrencyCode="GBP" ExtraMileageCharge=".00" UOM="MI" ChargeType="BaseRateTotal"
Amount="39.20" MileageAllowance="UNL"/>
<VehicleCharge ExtraMileageCharge=".00" UOM="MI" ChargeType="ExtraDay" Amount="43.12"
MileageAllowance="UNL"/>
<VehicleCharge ExtraMileageCharge=".00" UOM="MI" ChargeType="ApproximateTotalPrice"
Amount="235.20" MileageAllowance="UNL"/>
<VehicleCharges>
<Commission/>
<CarExtraCharges/>
<GuaranteePrepaid/>
<VehRentalRate>
<ConvertedVehRentalRate AvailabilityStatus="S" Category="G" GuaranteeInd="G" PriceChangeIndicator="true"
RateCode="2L" RateKey="lotsofencrypteddata" SupplierCurrency="false" RatePlanReturned="W"
RatePlanChangeIndicator="true" RateAssured="*" SellGuaranteeReq="G" PrepayDeposit="P" >
<Vehicle VehType="MBMN">
<SeatBeltsAndBagsInfo>
<SeatBelts Quantity="4"/>
<BagsInfo>
<Bags Size="Large" Quantity="0"/>
<Bags Size="Small" Quantity="2"/>
<BagsInfo>
<SeatBeltsAndBagsInfo>
<Vehicle>
<VehicleCharges>
<VehicleCharge CurrencyCode="USD" ExtraMileageCharge=".00" UOM="MI" ChargeType="BaseRateTotal"
Amount="50.72" MileageAllowance="UNL"/>
<VehicleCharge CurrencyCode="USD" ExtraMileageCharge=".00" UOM="MI" ChargeType="ExtraDay"
Amount="55.79" MileageAllowance="UNL"/>
<VehicleCharge CurrencyCode="USD" ExtraMileageCharge=".00" UOM="MI"
ChargeType="ApproximateTotalPrice" Amount="304.33" MileageAllowance="UNL"/>
<VehicleCharges>
<Commission Amount="75.77" Percent="20.000" Fixed=”false”/>
<CarExtraCharges TotalAmount="269.82">
<CarExtra BaseAmount="101.94" Code="NAV" Plan="B" Status="CNF"/>
<CarExtra BaseAmount="83.94" Code="CSI" Plan="B" Status="CNF"/>
<CarExtra BaseAmount="83.94" Code="CST" Plan="B" Status="CNF"/>
<CarExtra BaseAmount="0.00" Code="HCL" Plan="B" Status="CNF"/>
</CarExtraCharges>
<GuaranteePrepaid Amount="379.28" AmountPercentage="M" CurrencyCode="USD" Ind="P">
<CancellationAmount NumDays="331">25.00</CancellationAmount>
<CancellationAmount NumDays="2">50.00</CancellationAmount>
<CancellationAmount NumDays="1">100.00</CancellationAmount>
<CancellationAmount NumDays="0">379.28</CancellationAmount>
</GuaranteePrepaid>
<ConvertedVehRentalRate>
Repeat of VehRentalRate, except the monetary amounts and currency will be different
</VehAvailInfo>
</VehAvailInfos>
<VehLocPolicyInfos>
<VehLocPolicyinfo CounterLocation="A" LocationCode="DFW" ExtendedLocationCode="DFW" LocationName="DALLAS FORT
WORTH INTL" LocationOwner="C" LocationType="PickUp" PolicyRef="TRDFWDFW">
<VendorDetails Code="TR" Name="TESTRENT"/>
<LocationInfo>
<Address>
<AddressLine1>2424 EAST 38TH STREET</AddressLine1>
<AddressLine2>SUITE 200</AddressLine2>
<CityName>DALLAS</CityName>
<StateProv StateCode="TX"/>
<CountryName Code="US">United States</CountryName>
</Address>
</LocationInfo>
<OperationSchedule StartDate="2018-12-10">
<OperationTimes>
<OperationTime dayOftheWeek="2" end="2359" start="0500"/>
</OperationTimes>
</OperationSchedule>
</VehLocPolicyinfo>
<VehLocPolicyinfo CounterLocation="A" LocationCode="HOU" ExtendedLocationCode="HOU" LocationName="HOUSTON HOBBY
AIRPORT" LocationOwner="C" LocationType="DropOff" PolicyRef="TRHOUHOU">
<VendorDetails Code="TR" Name="TESTCAR"/>
<LocationInfo>
<Address>
<AddressLine1>1010 HOBBY AVE</AddressLine1>
<AddressLine2>SUITE 222</AddressLine2>
<CityName>HOUSTON</CityName>
<StateProv StateCode="TX"/>
<CountryName Code="US">United States</CountryName>
</Address>
</LocationInfo>
<OperationSchedule StartDate="2018-12-15">
<OperationTimes>
<OperationTime dayOftheWeek="7" start="0500" end="2359"/>
</OperationTimes>
</OperationSchedule>
</VehLocPolicyinfo>
</VehLocPolicyInfos>
</GetVehAvailRS>
<VehAvailInfos PickUpDate="2018-12-10" PickUpTime="0730" RentalDays="5" RentalHours="0" ReturnDate="2018-12-15"
ReturnTime="0930">
<VehAvailInfo>
<Vendor Code="TR" Logo="http://vcmp.sgdcelab.sabre.com/image/.....png "Name="TESTRENT"/>
<PickUpLocation Distance="W" Distance="3.94" LocationCode="DFW" ExtendedLocationCode="DFW"
Latitude="32.892" Longitude="-97.04" PolicyRef="TRDFWDFW"/>
<ReturnLocation Distance="NA" ExtendedLocationCode="HOU" LocationCode="HOU" PolicyRef="TRHOUHOU"/>
<VehRentalRate AvailabilityStatus="S" Category="G" GuaranteeInd="G" PriceChangeIndicator="true" RateCode="2L"
RateKey="lotsofencrypteddata" SupplierCurrency="true" RatePlanReturned="W" RatePlanChangeIndicator="true"
RateAssured="*" SellGuaranteeReq="G" PrepayDeposit="P" >
<Vehicle VehType="MBMN">
<SeatBeltsAndBagsInfo>
<SeatBelts Quantity="4"/>
<BagsInfo>
<Bags Size="Large" Quantity="0"/>
<Bags Size="Small" Quantity="2"/>
<BagsInfo>
<SeatBeltsAndBagsInfo>
<Vehicle>
<VehicleCharges>
<VehicleCharge CurrencyCode="GBP" ExtraMileageCharge=".00" UOM="MI" ChargeType="BaseRateTotal"
Amount="39.20" MileageAllowance="UNL"/>
<VehicleCharge ExtraMileageCharge=".00" UOM="MI" ChargeType="ExtraDay" Amount="43.12"
MileageAllowance="UNL"/>
<VehicleCharge ExtraMileageCharge=".00" UOM="MI" ChargeType="ApproximateTotalPrice"
Amount="235.20" MileageAllowance="UNL"/>
<VehicleCharges>
<Commission/>
<CarExtraCharges/>
<GuaranteePrepaid/>
<VehRentalRate>
<ConvertedVehRentalRate AvailabilityStatus="S" Category="G" GuaranteeInd="G" PriceChangeIndicator="true"
RateCode="2L" RateKey="lotsofencrypteddata" SupplierCurrency="false" RatePlanReturned="W"
RatePlanChangeIndicator="true" RateAssured="*" SellGuaranteeReq="G" PrepayDeposit="P" >
<Vehicle VehType="MBMN">
<SeatBeltsAndBagsInfo>
<SeatBelts Quantity="4"/>
<BagsInfo>
<Bags Size="Large" Quantity="0"/>
<Bags Size="Small" Quantity="2"/>
<BagsInfo>
<SeatBeltsAndBagsInfo>
<Vehicle>
<VehicleCharges>
<VehicleCharge CurrencyCode="USD" ExtraMileageCharge=".00" UOM="MI" ChargeType="BaseRateTotal"
Amount="50.72" MileageAllowance="UNL"/>
<VehicleCharge CurrencyCode="USD" ExtraMileageCharge=".00" UOM="MI" ChargeType="ExtraDay"
Amount="55.79" MileageAllowance="UNL"/>
<VehicleCharge CurrencyCode="USD" ExtraMileageCharge=".00" UOM="MI"
ChargeType="ApproximateTotalPrice" Amount="304.33" MileageAllowance="UNL"/>
<VehicleCharges>
<Commission Amount="75.77" Percent="20.000" Fixed=”false”/>
<CarExtraCharges TotalAmount="269.82">
<CarExtra BaseAmount="101.94" Code="NAV" Plan="B" Status="CNF"/>
<CarExtra BaseAmount="83.94" Code="CSI" Plan="B" Status="CNF"/>
<CarExtra BaseAmount="83.94" Code="CST" Plan="B" Status="CNF"/>
<CarExtra BaseAmount="0.00" Code="HCL" Plan="B" Status="CNF"/>
</CarExtraCharges>
<GuaranteePrepaid Amount="379.28" AmountPercentage="M" CurrencyCode="USD" Ind="P">
<CancellationAmount NumDays="331">25.00</CancellationAmount>
<CancellationAmount NumDays="2">50.00</CancellationAmount>
<CancellationAmount NumDays="1">100.00</CancellationAmount>
<CancellationAmount NumDays="0">379.28</CancellationAmount>
</GuaranteePrepaid>
<ConvertedVehRentalRate>
Repeat of VehRentalRate, except the monetary amounts and currency will be different
</VehAvailInfo>
</VehAvailInfos>
<VehLocPolicyInfos>
<VehLocPolicyinfo CounterLocation="A" LocationCode="DFW" ExtendedLocationCode="DFW" LocationName="DALLAS FORT
WORTH INTL" LocationOwner="C" LocationType="PickUp" PolicyRef="TRDFWDFW">
<VendorDetails Code="TR" Name="TESTRENT"/>
<LocationInfo>
<Address>
<AddressLine1>2424 EAST 38TH STREET</AddressLine1>
<AddressLine2>SUITE 200</AddressLine2>
<CityName>DALLAS</CityName>
<StateProv StateCode="TX"/>
<CountryName Code="US">United States</CountryName>
</Address>
</LocationInfo>
<OperationSchedule StartDate="2018-12-10">
<OperationTimes>
<OperationTime dayOftheWeek="2" end="2359" start="0500"/>
</OperationTimes>
</OperationSchedule>
</VehLocPolicyinfo>
<VehLocPolicyinfo CounterLocation="A" LocationCode="HOU" ExtendedLocationCode="HOU" LocationName="HOUSTON HOBBY
AIRPORT" LocationOwner="C" LocationType="DropOff" PolicyRef="TRHOUHOU">
<VendorDetails Code="TR" Name="TESTCAR"/>
<LocationInfo>
<Address>
<AddressLine1>1010 HOBBY AVE</AddressLine1>
<AddressLine2>SUITE 222</AddressLine2>
<CityName>HOUSTON</CityName>
<StateProv StateCode="TX"/>
<CountryName Code="US">United States</CountryName>
</Address>
</LocationInfo>
<OperationSchedule StartDate="2018-12-15">
<OperationTimes>
<OperationTime dayOftheWeek="7" start="0500" end="2359"/>
</OperationTimes>
</OperationSchedule>
</VehLocPolicyinfo>
</VehLocPolicyInfos>
</GetVehAvailRS>
XML Error Response Structure
<GetVehAvailRS>
<ApplicationResults status="Incomplete">
<Error type="Application" timeStamp="2018-12-21T10:15:09.913-06:00">
<SystemSpecificResults>
<Message code="ERR.NGCP-DISTRIBUTION.API_PROCESS_RQ">NO RATES QUALIFY<Message>
</SystemSpecificResults>
</Error>
</ApplicationResults>
</GetVehAvailRS>
<ApplicationResults status="Incomplete">
<Error type="Application" timeStamp="2018-12-21T10:15:09.913-06:00">
<SystemSpecificResults>
<Message code="ERR.NGCP-DISTRIBUTION.API_PROCESS_RQ">NO RATES QUALIFY<Message>
</SystemSpecificResults>
</Error>
</ApplicationResults>
</GetVehAvailRS>