XML Response Definitions

`<GetVehAvailRS/>`

This is the beginning of the response.

`<VehAvailInfos>`

The Vehicle Availability Information element is the beginning of critical information relating to the booking.

`PickUpDate="yyyy-mm-dd"`

The date of the vehicle pick up in year-month-day format. This attribute will always display.

`PickUpTime=" "`

The time of the vehicle pick up in 24-hour clock format. This attribute will always display.

`ReturnDate="yyyy-mm-dd"`

The vehicle return date in year-month-day format. This attribute will always display.

`ReturnTime=" "`

The vehicle return time in 24 hour clock format. This attribute will always display.

`RentalDays=" "`

The rental days attribute will always display and is a 1-3 numeric value.

A "day" is a 24-hour period of time based on when the car was picked up.

For a single location, single car supplier response, this attribute contains the actual number of days the car supplier used to determine the type of rate returned.

For all other responses, this attribute contains the number of days and hours in the request, as it is the difference between pickup date/time and return date/time. This is done because each supplier may round up or down on the length of rental to determine the rates returned.

`RentalHours=" "`

The rental hours attribute will always display and is a 1-2 numeric value.

A "day" is a 24-hour period of time based on the time the car was picked up.

For single location, single car supplier responses, this attribute contains the actual number of hours the car supplier used to determine the type of rate returned.

For all other responses, this attribute contains the number of days and hours in the request as the difference between pickup date/time and return date/time. This is done because each supplier may round up or down on the length of rental to determine the rates returned.

Example: <VehAvailInfos PickUpDate="2018-12-12" PickUpTime="0730" RentalDays="14" RentalHours="0" ReturnDate="2018-12-26" ReturnTime="0730">

`<VehAvailInfo>`

This is the beginning of the Vehicle Availability Information.

`<Vendor Code=" "Logo="url addr" Name=" "/>`

The Vendor element is mandatory and contains car supplier code, Logo URL, and name information.

`Code=" "`

The vendor (car supplier) code attribute will always display and is a 2 alpha value.

`Logo=" "`

The logo attribute is returned if the request in GetVehAvailRQ contained the ImagesRef element.

If Logo was used in the request, this attribute will contain a URL to retrieve the logo provided by the car supplier.

`Name=" "`

The car supplier company name attribute will always display and can be from 1 to 10 characters long.

Example: <Vendor Code="TR" Logo="http://vcmp.sgdcelab.sabre.com/image/upload/f_auto,q_auto:best,t_vcmp_logo/car/l/tr/TRZI.png" Name="TESTRENT"/>

`<PickUpLocation>`

The pickup location element will always display, and returns unique Sabre policy references, city location codes, latitude/longitude. Depending on the request, the direction and distance from the requested location may also display.

`PolicyRef=" "`

The policy reference attribute will always display.

The policy reference is the unique ID of the car supplier rental location, and is comprised of the 2 character car supplier code, 3 character city code, and the same 3 character code if an airport location, or 4 character location code.

`LocationCode=" "`

The location code attribute will always display. The location code is a 3 alpha value designating the IATA airport code.

`ExtendedLocationCode=" "`

If a non-airport code is used in the request, then the values in this field will consist of 1 alpha character and 1-3 numeric characters.

The 1 alpha character designates the type of non-airport; either by direction or type code:

N-north
S-south
E-east
W-west
R-resort
X-rail
P-port
C-city

`Direction=" "`

The direction attribute will always display if the request contained GeoRef.

The direction attribute can be one of the following:

N-north
S-south
E-east
W-west
Combined NE, NW, SE, SW
NA-(Not available) the latitude and longitude are not exact

`Distance=" "`

The distance attribute will always display if the request contained GeoRef.

The distance attribute is between 1 and 3 characters, with a maximum value of 200.

Important! The only time the distance attribute is empty is when Direction contains NA for Not Available.

`UOM=" "`

The unit of measure attribute will always display if the request contained GeoRef. If used, the value for this field will be MI- miles or KM- kilometers.

`Latitude=" " Longitude=" "`

The latitude and longitude attributes are optional, but are present on all GeoRef requests and are usually used as part of the sorting criteria to return the closest location first.

The latitude and longitude are displayed in signed degree (DDD.dddddd) format.

Pickup Location example:

Return Location provides a unique Sabre policy reference, city location codes, latitude/longitude, and depending on the request, the direction and distance from a requested location.

`PolicyRef=" "`

The policy reference attribute will always display.

`LocationCode=" "`

The location code attribute will always display. The location code is a 3 alpha value designating the IATA airport code or city.

`ExtendedLocationCode=" "`

If a non-airport code is used in the request, then the values in this field will consist of 1 alpha character and 1-3 numeric characters.

The 1 alpha character designates the type of non-airport; either by direction or type code:

N-north
S-south
E-east
W-west
R-resort
X-rail
P-port
C-city

`Direction=" "`

The direction attribute will always display if the request contained GeoRef.

The direction attribute can be one of the following:

N-north
S-south
E-east
W-west
Combined NE, NW, SE, SW
NA-(Not available) the latitude and longitude are not exact

`Distance=" "`

The distance attribute will always display if the request contained GeoRef.

The distance attribute is between 1 and 3 characters, with a maximum value of 200.

Important! The only time the distance attribute is empty is when Direction contains NA for Not Available.

UOM=" "

The unit of measure attribute will always display if the request contained GeoRef. If used, the value for this field will be MI- miles or KM- kilometers.

`Latitude=" " Longitude=" "`

The latitude and longitude attributes are optional, but are present on all GeoRef requests and are usually used as part of the sorting criteria to return the closest location first.

The latitude and longitude are displayed in signed degree (DDD.dddddd) format.

Latitude and longitude will not display if the Direction is NA. They are only approximate coordinates.

Sample of Return Location: <ReturnLocation Direction="N" Distance="18.75" ExtendedLocationCode="C001" Latitude="37.7878" LocationCode="SFO" Longitude="-122.413" PolicyRef="ZISFOC001" UOM="KM"/>

`<VehRentalRate>`

The vehicle rental rate element contains all details pertaining to a rental rate and may or may not be present in the response.

If this element is not present, then ConvertedVehRentalRate will be present in the response.

`AvailabilityStatus=" "`

Determines whether the vehicle is ready for rental or is available on request. Can be:

S for Sell
R for On Request

`Category=" "`

Designate the types of a rate. Can be:

L - Inclusive
C - Corporate

`GuaranteeInd=" "`

Guarantee Indicator identifies whether the rate is guaranteed. Can be:

G for guarantee
Q for on request (quoted)
C for closed

Note: Almost all responses will be G.

`PriceChangeIndicator=" "`

If true, the rate plan returned by the car supplier is a different type than what was requested based on rental length.

Example: GetVehAvailRS includes W for weekly, but the booking response would return D for daily.

`RateCode=" "`

Car supplier-specific 2-6 alpha numeric code tied to the available rate. This is similar to an airline fare code.

`RateKey=" "`

The rate key is the encrypted form of a rate. This field will always display.

`SupplierCurrency=" "`

If true, all monetary amounts are in the currency the car supplier returned to Sabre.

In the <VehRentalRate…> element, this value will always be set to true.

All monetary amounts are the actual amounts that will be used for booking the vehicle in the currency listed within <VehicleCharge…>.

This currency applies to all monetary amounts within <VehRentalRate>.

`RatePlanReturned=" "`

Rate Plan is used to describe the length of the car rental to determine the rate, which is based on the difference between pickup date/time and return date/time in days and hours.

Possible rate plans include:

D-daily
E-weekend
W-weekly
M-monthly
B-bundled (length of rental)

Vehicle Rental Rate Example: <VehRentalRate AvailabilityStatus="S" GuaranteeInd="G" PriceChangeIndicator="1" RateCode="2L" SupplierCurrency="true" RatePlanReturned="W">

`SellGuaranteeReq=" "`

Indicates whether the supplier requires an up-front payment or a guarantee.

The possible sell guarantee required value is ‘G’.

The Guarantee of the booking is needed, in case the traveler is a no show and the booking was not cancelled in advance.

`RateAssured=" "`

The rate assured indicator means that the supplier has contractually agreed with Sabre to always display the lowest publicly available rate and there is no need to check other sources for a lower publicly available rate. If present, the value must be *.

`PrepayDeposit=" "`

Indicates that the rate is based on a payment restriction. This value is 1 character, and possible values include: prepay P, deposit D, and guarantee G.

P or D indicates that at the time of booking, the vehicle rate and credit card are required, and will be charged after booking.

`RatePlanChangeIndicator=" "`

This value may be present for AirportRef or GeoRef requests. These types of requests have multiple Car Supplier responses and Sabre requires response to be the same for all suppliers to allow for easy comparisons.

If present, the value must be true. True indicates that at the time of booking, the vehicle rate and the RatePlan will change to what the Car Supplier used to determine the total price.

Example:

<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=" ">`

The Vehicle element provides car type code information.

`VehType=" "`

This attribute is a 4 alpha code that identifies the type of vehicle. For a full list of Vehicle Types, refer to the Vehicle Types Matrix.

`<SeatBeltsAndBagsInfo>`

The seatbelts and bags information element will almost always be present, and contains vehicle capacity information.

`<SeatBelts Quantity=" "/>`

The seatbelts element will almost always be present, and contains vehicle capacity information.

`Quantity=" "`

The quantity attribute will always display if the Seatbelts element is present.

The seat belt quantity is a 1-2 numeric value that quantifies the legal occupancy of the vehicle.

Example: <SeatBelts Quantity="4"/>

`<BagsInfo>`

The Bags Information element lists the number of bags the vehicle holds, and will almost always be present in the response.

`<Bags Quantity=" " Size=" "/>`

The Bags element lists the number of small or large bags the vehicle can hold.

`Quantity=" "`

The quantity is 1-2 numeric value that determines the number of bags the vehicle can hold.

`Size=" "`

Bag sizes can be either Small or Large.

Small – the bag meets the airline definition of a carry on: 22" L x 14" W x 9" H
Large – the bag size meets the airline definition of checked baggage: Maximum of 62” when adding length, width, and height

Example: <Bags Quantity="1" Size="Large"/>

`</BagsInfo>`

Marks the end of the Bags Information element.

Example:

`</SeatBeltsAndBagsInfo>`

Marks the end of the Seatbelts and Bags Information element.

Example:

`<Images>`

The Images element will only be returned if the request in GetVehAvailRQ contains the ImagesRef element, and if images are available for the vehicle requested for the car supplier in the country.

`<Image>`

The Image element contains individual image information, and will only display if the Images element is present.

`Url=" "`

The link to car supplier-provided image associated with the vehicle.

`Type=" "`

The type attribute must be one of the following:

Original
Thumbnail: scalable to 100 x 150
Small: scalable to 200 x 200
Medium: scalable to 400 x 400
Large: scalable to 800 x 800

`Height=" "`

1-2 numeric value of the image size height.

`Width=" "`

1-2 numeric value of the image size width.

`<Images/>`

Marks the end of Images element.

Example:

`</Vehicle>`

Marks the end of the Vehicle element.

Example:

`<VehicleCharges>`

This element marks the beginning of Vehicle Charge information.

The vehicle charge elmenta and attributes are mandatory.

`Amount=" "`

The monetary amount of the charge. The amount is a 1-13 numeric value, or can be up to 12 with one decimal point.

`ChargeType=" "`

The charge type attribute can be one of the following:

BaseRateTotal – Primary rate total before taxes and fees
ExtraDay – Charge for additional day if the vehicle is not returned on time
ExtraHour – Charge for each additional hour that the vehicle is not returned on time
ApproximateTotalPrice – Estimated total price including taxes, fees, and car extras.

`CurrencyCode=" "`

The 3 alpha ISO currency code.

`ExtraMileageCharge=" "`

The extra mileage charge is a non-zero value when the mileage allowance is not UNL (unlimited).

`MileageAllowance=" "`

If hour is present, this attribute will be populated.

The mileage allowance can be UNL for unlimited, or a 1-5 numeric value that signifies the distance limit allowed for an extra hour of rental.

If the base rate mileage amount has UNL, then the extra hour must have UNL as well.

`</VehicleCharges>`

This marks the end of the Vehicle Charges element.

`<Commission>`

Contains the commission amount the travel agency will receive.

`Amount=" "`

The monetary amount of the commission.

The amount attribute is 1-12 numeric value that can include up to 1 decimal point.

`Percent=" "`

The commission percent is a 1-3 numeric value following by a decimal point, then an additional 3 numeric value.

If this attribute is not present, then Fixed is true. Most car suppliers use a true percentage, not fixed.

`Fixed=" "`

The fixed amount of the commission.

The fixed attribute must be false if the Percent attribute is present.

Example:

`<CarExtraCharges/>`

If the Car Extra Charges element is present, it will contain the TotalAmount attribute and CarExtra’ child element(s).

Note: Some suppliers do not support this element.

`TotalAmount=" "`

The total amount is a 1-13 numeric value, or up to 12 numeric, with one decimal point.

`<CarExtra>`

The Car Extras element will always display if CarExtraCharges is present.

The car extra can repeat up to 10 times.

Most car supplier support up to 4 repeats of Car Extra, with a few supporting up to 10.

`BaseAmount=" "`

The Base Amount is a 1-13 numeric value, or up to 12 numeric, with one decimal point.

`Code=" "`

The car extra code attribute will always display if CarExtras is present.

All car suppliers support equipment items, such as CST – Child Seat, and NAV – Navigation.

Some support service items, such as TOL – toll road tags, and PAI – Insurance code.

A few support surcharge items, such as A18 – age 18 driver surcharge.

All items are potentially valid. They are edited against the car supplier's car rental location policy for shop requests and only codes valid for that car supplier location are sent to that specific car supplier.

Car suppliers are allowed their own custom codes. For example, some countries allow surcharges on overage drivers, so a car supplier may have added A75 – Renter Age 75 at time of rental.

Refer to the Sabre Car Special Equipment Code Matrix for all applicable Sabre values.

`Plan=" "`

Plan will always display if CarExtraCharges is present.

The plan is a 1 alpha value that can be:

D-daily
E-weekend
W-weekly
M-monthly
B-bundled (length of rental)

`Status=" ">`

The status will always display if CarExtraCharges is present.

The status is a 3 alpha value and will contain one of the following:

Confirmed CNF
On Request ONR
Not Available NTA

`</CarExtraCharges>`

This marks the end of the Car Extra Charges element.

Example:

`<GuaranteePrepaid>`

The guarantee prepaid element returns amount details, and whether the amount is guaranteed or prepaid.

Guarantee Prepaid is optional, but if present, all attributes within will always display.

`Amount=" "`

The Amount attribute is a 1-13 numeric value, or can be up to 12 numeric with one decimal point included.

The Amount is the total amount to be guaranteed and charged at the time of pickup, whether the customer shows or not. This value also represents the total amount to be prepaid at the time of booking.

`AmountPercentage=" "`

The amount percentage is 1 alpha value, and can be: M for monetary or P for percentage.

`CurrencyCode=" "`

The 3 alpha ISO currency code.

`Ind=" ">`

Indicator is a 1 alpha and can be: G for guarantee or P for prepaid.

Example: <GuaranteePrepaid Amount="379.28" AmountPercentage="M" CurrencyCode="USD" Ind="P">

`GuaranteePrepaid` Children

The guarantee prepaid child/children elements contain at least 1, but may have up to 4, occurrence(s) of CancellationAmount.

`<CancellationRefundAmount DaysPrior=" " Amount=” “/>`

The Cancellation Amount element details the refund amount to be received in the event of a cancellation. This element has one attribute followed by one monetary or percentage amount.

Note: The amount is always a cancellation amount.

`DaysPrior="331">`

The number days covers the entire amount of time from the date and time of booking through the pickup date and time.

The number of days is a 1 to 3 numeric value.

Important! The highest value is 331 days, the maximum number of days a car booking can be made.

The value following this attribute is the monetary value or percentage of the cancellation amount.

If Ind="M", then the value is a 1-13 numeric (or up to 12 with one decimal point) monetary value.
If Ind="P", then the value is a 1-5 numeric (with up to 1 decimal point, with no more than 3 numeric values to the right of the decimal) value indicating a percentage.

`</CancellationRefundAmount>`

This marks the end of one Cancellation Amount element.

`</GuaranteePrepaid>`

This marks the end of the Guarantee Prepaid element.

Example:

Note: If the item repeats, the Amount is used for the period between the two occurrences. In this example, the penalty amount is 100 dollars from a 331 days prior to the booking date through 2 days of booking (1 day greater than the next DaysPrior).

`</VehRentalRate>`

This marks the end of the Vehicle Rental Rate element.

`<ConvertedVehRentalRate AvailabilityStatus=" " Category=" " GuaranteeInd=" " PriceChangeIndicator=" " RateCode=" " RateKey="lotsofencrypteddata" SupplierCurrency=" " RatePlanReturned=" " >SellGuaranteeReq=" " RateAssured=" " PrepayDeposit=" " RatePlanChangeIndicator=" ">`

The ConvertedVehRentalRate repeats all elements/attributes from VehRentalRate through /VehRentalRate. If not present, then VehRentalRate will be present.

The AvailabilityStatus, Category, GuaranteeInd, PriceChaneIndicator, RateCode, RateKey, RatePlanReturned, SellGuaranteeReq, RateAssured, PrepayDeposit, and RatePlanChangeIndicator definitions are exactly the same as in VehRentalRate.

SupplierCurrency has an additional option of false; this means the rate is converted to the requested currency. true means the rate is NOT converted to the requested currency; the supplier supports the requested currency.

`</VehAvailInfo>`

This marks the end of Vehicle Availability Information for a single vehicle.

`</VehAvailInfos>`

This marks the end of all Vehicle Availability Information.

`<VehLocPolicyInfos>`

This marks the beginning of all Car Rental Locations Summary information.

`<VehLocPolicyinfo>`

This element contains city location codes and the rental counter/shuttle indicator.

`CounterLocation=" "`

Describes where the physical car rental pickup/drop off counter is located.

If ExtendedLocationCode is not equal to LocationCode, then CounterLocation is always N for non-airport location.

NON AIRPORT LOCATION - N
IN TERMINAL - I
OFF AIRPORT/RENTAL SHUTTLE - F
IN TERMINAL/RENTAL SHUTTLE - S
ON AIRPORT/RENTAL SHUTTLE - O
ON AIRPORT/AIRPORT SHUTTLE - A
CALL FOR SHUTTLE - C
2 SHUTTLES AIRPORT AND RENTAL - M

`LocationCode=" "`

The location code attribute will always display. The location code is a 3 alpha value designating the IATA airport code or city.

`ExtendedLocationCode=" "`

If a non-airport code is used in the request, then the values in this field will consist of 1 alpha character and 1-3 numeric characters.

The 1 alpha character designates the type of non-airport; either by direction or type code:

N-north
S-south
E-east
W-west
R-resort
X-rail
P-port
C-city

`LocationName=" "`

The 1-26 character name of the location.

`LocationOwner=" "`

Describes the ownership type of the car rental location. Can be:

C – Corporate owned location
F – Franchise owned location

`LocationType=" "`

Describes whether the data provided is for reantal pick up or drop-off. Can be:

PickUp
DropOff

`PolicyRef=" "`

The Policy Reference is comprised of the 2 character supplier code, combined with the 3 character city code, and the 2-4 character extended location code.

Example: <VehLocPolicyinfo CounterLocation="N" ExtendedLocationCode="C001" LocationCode="SFO" LocationName="SFOC01 UNION SQUARE POST ST" LocationOwner="C" LocationType="PickUp" PolicyRef="TRSFOC001">

`<VendorDetails>`

The Vendor Details element provides the car supplier's unique 2 character code and name.

`Code=" "`

The car supplier's unique 2 alpha code.

`Name=" "`

The name of the car supplier. Can be between 1 to 10 characters.

Example: <VendorDetails Code="TR" Name="TESTRENT"/>

`<LocationInfo Latitude=" " Longitude=" ">`

The latitude and longitude attributes are almost always present in the request for the LocationInfo element. If they are not present, the geocode entered in the request was not exact.

For example, if the address provided by the car supplier only geocodes to the city level, then it is accurate enough to show it is in or near a city, but not good enough to plot on a map.

The latitude and longitude are displayed in signed degree (DDD.dddddd) format.

Example: <LocationInfo Latitude="-12.123456" Longitude="123.123456"/>

`<Address>`

Marks the beginning of the address element.

`<Name>`

The address name is a 1-30 alpha value that may include periods and commas.

`</Name>`

Marks the end of the Name element.

Example: <Name>TESTRENT DOWNTOWN</Name>

`<AddressLine1>`

The address line 1 is the official address of the location. Can be 1-40 alpha, numeric, and can include spaces, commas, and periods.

Example: <AddressLine1>7366 CEDAR SPRINGS RD</AddressLine1>

`<AddressLine2>`

Contains additional address information. For example, Suite 222 or located in XYZ Hotel.

The address line 2 can be 1-40 alpha, numeric, and can include spaces, commas, and periods.

Example: <AddressLine2>SUITE 222</AddressLine2>

`<CityName>`

The full name of the city. Can be 1-25 alpha, and includes periods and commas.

`</CityName>`

Marks the end of the city name element.

Example: <CityName>DALLAS</CityName>

`<StateProv StateCode=" "/>`

The state province state code element will always display for USA locations, and is optional for all other locations.

The state province state code is a 2-3 alpha value.

Example: <StateProv StateCode="TX"/>

`<CountryName Code=" ">name</CountryName>`

Provides the full name and abbreviated code of the country where the car rental counter is located.

`Code=" "`

The two letter country code.

`<CountryName Code=" ">name`

The full name of the country. Can be between 1-55 characters.

`</CountryCode>`

Marks the end of Country Code element.

Example: <CountryName Code=US>United States</CountryCode>

`<PostalCode>`

The postal code is a 1-11 alpha, numeric value that can include spaces and dashes.

`</PostalCode>`

Marks the end of the Postal Code element.

Example: <PostalCode>75012-1234</PostalCode>

`</Address>`

Marks the end of the Address element.

Example:

<Address>
<Name>TESTRENT DOWNTOWN</Name>
<AddressLine1>7366 CEDAR SPRINGS RD </AddressLine1> <AddressLine2>SUITE 222</AddressLine2>
<CityName>DALLAS</CityName>
<StateProv StateCode="TX"/>
<CountryName Code=US>United States</CountryCode>
<PostalCode>75012-1234</PostalCode>
</Address>

`</LocationInfo>`

Marks the end of the Location Information element.

`<OperationSchedule StartDate="yyyy-mm-dd">`

The Operation Schedule element marks the beginning of the hours of operation information for the car rental location.

`StartDate="yyyy-mm-dd"`

The start date contains the date the operation hours are valid within.

`<OperationTimes>`

The Operation Times element contains the open and close times of the car rental location.

`<OperationTime DayOfTheWeek=" " Start="00:00" End="23:59"/>`

Identifies the open (start) and close (end) times of the car rental location in 24 hour format.

`dayOftheWeek=" "`

Can be:

Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

`Start=" "`

The opening time in 24 hour format.

`End=" "`

The closing time in 24 hour format.

`<OperationTime>`

The Operation Time is always based on the day of the week. For example, a location open from 6am to 1am every day of the week would show as two sets of time:

`</OperationTimes>`

Marks the end of the Operation Times response.

Example:

`</OperationSchedule>`

Marks the end of the operation schedule response.

Example:

`</VehLocPolicyinfo>`

Marks the end of the information for one car rental location.

`</VehLocPolicyInfos>`

Marks the end of all car rental location summary information.

`</GetVehAvailRS>`

Marks the end of the Get Vehicle Availability response.