Car Locations Elements

 

This section contains Car Location API schema and descriptions for all elements, attributes, and child elements found within the API.

Use Ctrl+F to locate specific elements or attributes. All code is pre-formatted, and may be copied and pasted directly into an API testing tool. Code headers/identifiers are displayed using XPath format.

API Information

Target Audience
All Sabre APIs Customers
Current Version
2.3.0
Authentication
Session Token
Service Action Code
VehLocationFinderLLSRQ

Design Documentation

View in an XML format below:

Quick Links

Browse documentation on this page:

Request Header

<VehLocationFinderRQ xmlns="http://webservices.sabre.com/sabreXML/2011/10" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="2.2.0">

Request Sample

<VehLocationFinderRQ xmlns="http://webservices.sabre.com/sabreXML/2011/10" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="2.2.0">
    <VehAvailRQCore>
        <LocationDetails Distance="25" Direction="E" NumLocations="2" UnitOfMeasure="MI"/>
            <Address>
                <StreetNmbr>123 Main St</StreetNmbr>
                <PostalCode>75010</PostalCode>
                <StateCountyProv StateCode="TX"/>
            </Address>
        <LocationDetails DropOff="true" Latitude="40.754839" Longitude="-73.710929"/>
        <RateQualifier CurrencyCode="" Commission="true" RateAssured="true" RateCode="XX1234,YY5678" RateCategory="" RatePlan="M">
            <GuaranteePrepaid ReturnGuaranteedRates="true" ReturnPrepaidRates="true" ReturnRegularRates="true"/>
            <Corporate>
                <ID>XXABC123,YYDEF456</ID>
            </Corporate>
            <Promotion>
                <Code>XXPC1234,YY7890PC</Code>
            </Promotion>
            <TourCode>
                <Text>XXTOUR2468,YY1357USA</Text>
            </TourCode>
            <ID>
                <Number>XXID02468,YY01357ID</Number>
            </ID>
        </RateQualifier>
        <SpecialEquipPrefs>
            <SpecialEquipPref EquipType="CST"/>
            <SpecialEquipPref EquipType="HCL"/>
        </SpecialEquipPrefs>
        <VehPrefs>
            <VehPref>
                <VehType>ICAR</VehType>
                <VehType>LCAR</VehType>
            </VehPref>
        </VehPrefs>
        <VehRentalCore PickUpDateTime="02-02T12:00" ReturnDateTime="02-23T12:00">
            <VendorPrefs>
                <VendorPref Code="XX"/>
                <VendorPref Code="YY"/>
            </VendorPrefs>
    </VehAvailRQCore>
</VehLocationFinderRQ>

Request Elements

/VehAvailRQCore

This element signals the beginning of the Vehicle Location Finder request.

/VehAvailRQCore/LocationDetails

LocationDetails provides the search criteria for the closest car rental location(s) for both pick up and drop off.

This element can only be used up to two (2) times, if the second occurence is for drop off. This element can only occur once for pick up.

This element defaults to 10 miles and 1 location if attributes are omitted.

Attributes

Name
Description
@Distance

Optional

1-3 numerical value denoting the radius in which to search. The maximum value is 200.

To request a distance radius other than the default of 10 miles, enter:

<LocationDetails Distance="200"/>
@DropOff

Optional

A true or false value:

  • If false, the attribute is omitted.
  • If true, use the latitude/longitude attributes OR the drop off children elements to locate rental locations where the car can be returned for one-way rentals. If the car is being returned to the same location, this attribute should not be used.

To request drop off, enter:

<LocationDetails DropOff="true"/>
@Latitude

Optional

The latitude of the drop off location in -(1-2 numeric, decimal, 6 numeric) format. Must be used together with @Longitude.

Together with @Longitude, these attributes are the most common method used to supply the API with pickup or drop off search criteria. If these are not used, the location details children elements must be used.

To enter latitude/longitude:

<LocationDetails Latitude="-12.123456" Longititude="123.123456"/>
@Longitude

Optional

The longitude of the drop off location in -(1-3 numeric, decimal, 6 numeric) format. Must be used together with @Latitude.

Together with @Latitude, these attributes are the most common method used to supply the API with pickup or drop off search criteria. If these are not used, the location details children elements must be used.

To enter latitiude/longitude:

<LocationDetails Latitude="-12.123456" Longititude="123.123456"/>
@Direction

Optional

The direction in "N" north, "S" south, "E" east, "W" west, "NE", "NW", "SE", or "SW" format. This attribute limits the search of rental locations to a requested direction from the pick up location point entered.

To request a direction, enter:

<LocationDetails Direction="E"/>
@NumLocations

Optional

A 1-2 numerical value used when the amount of rental locations returned per supplier needs to be more than a single closest location. If only one location per supplier is needed, omit this attribute.

This number must be between 2-20. If above 6, the maximum distance entered can be no more than 10.

To request a number of locations above 1, enter:

<LocationDetails NumLocations="2"/>
@UnitOfMeasure

Optional

The unit of measurement for the distance in "MI" miles, or "KM" kilometers. The default value is "MI", and the attribute should be omitted if only searching in miles.

To request kilometers, enter:

<LocationDetails UnitOfMeasure="KM"/>

To request a drop off location using LocationDetails, enter:

<LocationDetails Distance="25" Latitude="40.641311" Longitude="-73.778139" Direction="E" NumLocations="2" UnitOfMeasure="MI"/>
    <LocationDetails DropOff=”true” Latitude="12.123456" Longitude="-123.987654"/>

Children

LocationDetails children are used to determine the center of a search radius. These child elements must be used if the latitude and longitude attributes are not used.

Name
Description
//Address

Optional, Required when @Latitude and @Longitude are used

An address to determine center of the search radius.

//Address/CityName

Optional, Required when a street number has been entered

The 1-45 character name of the city to be used as a point of interest.

//Address/StreetNmbr

Optional

A 1-45 alpha numeric value containing the street number and street name. This element is optional, but when used, must be in conjunction with the city name or postal code.

//Adress/PostalCode

Optional

The 1-11 numeric postal code of the point of interest. This value may also include spaces or dashes.

If the postal code is used, //CountryCode is mandatory if not in the US. If in the US, a valid //StateCountyProv/@StateCode is required.

//Address/StateCountyProv/@StateCode

Optional, Required if US is the country code

Used to help narrow down the proper city when multiple city names in the same country are present.

//Address/CountryCode

Required, unless a valid US state code is entered into //StateCountyProv/@StateCode

The ISO 3166-1 country code.

//PointOfInterest

Optional

A specific point of interest, such as an attraction, monument, or building, with which to base the search radius. When used, the minimum required address information is relaxed to one element, and must be used in conjunction with the Address:

  • CountryCode
  • StateCode is a US state is entered
Note: Although the minium required value for this field is one Address child element, the more entered, the more likely an exact match will occur.
//RailStation

Optional

Further narrows down the radial search by nearby rail station. When used, the minimum required address information is relaxed to one element, and must be used in conjunction with the Address:

  • CityName OR PostalCode AND CountryCode
  • CityName OR PostalCode AND StateCountyProv StateCode, if a US state is entered
Note: Although the minium required value for this field is one Address child element, the more entered, the more likely an exact match will occur.
//HotelSearchCriteria

Optional

The Sabre hotel property on which to base the search radius. This is a very rarely used option, as users must know either the Sabre hotel property number or have a segment reference.

//HotelSearchCriteria/Criterion

Optional, Required if HotelSearchCriteria is used

Used to enter the hotel code or segement number.

//HotelSearchCriteria/Criterion/HotelRef/@HotelCode

Optional

A 1-7 numeric code denoting the hotel property number obtained from a Sabre hotel booking.

//HotelSearchCriteria/Criterion/SegmentNumber

Optional

A 1-2 numeric value denoting the hotel booking segment number. This value is only used by APIs that are able to maintain a session throughout the entirety of the process. Most API users do not have this functionality.

Address Examples

To request the center of a postal code for the US, enter:

<LocationDetails>
    <Address>
        <PostalCode>75010</PostalCode>
        <StateCountyProv StateCode="TX"/>
    </Address>
</LocationDetails>

To request the center of a postal code for a country other than the US, enter:

<LocationDetails>
    <Address>
        <PostalCode>TW6 2QD</PostalCode>
        <CountryCode>GB</CountryCode>
    </Address>
</LocationDetails>

To request the center of a city for the United States, enter:

<LocationDetails>
    <Address>
        <CityName>Dallas</CityName>
        <StateCountyProv StateCode="TX"/>
    </Address>
</LocationDetails>

To request the center of a city for any country BUT the United States, enter:

<LocationDetails>
    <Address>
        <CityName>London</CityName>
        <CountryCode>GB</CountryCode>
    </Address>
</LocationDetails>

Address + Street Number Examples

To request a specific street address by city name, enter:

<LocationDetails>
    <Address>
        <StreetNmbr>123 Central Ave</StreetNmbr>
        <CityName>London</CityName>
        <CountryCode>GB</CountryCode>
    </Address>
</LocationDetails>

To request a specific address by postal code in the US, enter:

<LocationDetails>
    <Address>
        <StreetNmbr>123 Main St</StreetNmbr>
        <PostalCode>75010</PostalCode>
        <StateCountyProv StateCode="TX"/>
    </Address>
</LocationDetails>

Address + Point Of Interest Examples

To request a specific point of interest in a country, enter:

<LocationDetails>
    <Address>
        <CountryCode>GB</CountryCode>
    </Address>
    <PointOfInterest>London Tower</PointOfInterest>
</LocationDetails>

To request a specific point of interest in the US using a state code, enter:

<LocationDetails>
    <Address>
        <StateCountyProv StateCode="NY"/>
    </Address>
    <PointOfInterest>Times Square</PointOfInterest>
</LocationDetails>

Address + Rail Station Examples

To request a specific rail station in a city and not in the US, enter:

<LocationDetails>
    <Address>
        <CityName>London</CityName>
        <CountryCode>GB</CountryCode>
    </Address>
    <RailStation>Victoria</RailStation>
</LocationDetails>

To request a specific rail station in the US using a state code, enter:

<LocationDetails>
    <Address>
        <CityName>Dallas</CityName>
        <StateCountyProv StateCode="TX"/>
    </Address>
    <RailStation>Amtrak-Dallas</RailStation>
</LocationDetails>

Address + Hotel Search Criteria Examples

To request by hotel property number, enter:

<LocationDetails>
    <HotelSearchCriteria>
        <Criterion>
            <HotelRef HotelCode="03797"/>
        </Criterion>
    </HotelSearchCriteria>
</LocationDetails>

To request by hotel property number by segment in the hotel booking, enter:

<LocationDetails>
    <HotelSearchCriteria>
        <Criterion>
            <SegmentNumber="1"/>
        </Criterion>
    </HotelSearchCriteria>
</LocationDetails>

 

/VehAvailRQCore/RateQualifier

The RateQualifier element contains attributes and child elements. If there are no rate qualifiers, there is no need to enter values.

Attributes

The RateQualifier attributes should be combined into one string if used in the request:

<RateQualifier CurrencyCode="USD" Commission="true"  RateAssured="true" RateCategory="G" RatePlan="D">

Note: These attributes are omitted if false or are not used in the request.

Name
Description

@CurrencyCode

Optional

The 3 letter ISO 4217 currency code.

@Commission

Optional

Used to request only the suppliers that return comission information. If this field is omitted, the response will contain information from both car suppliers that return commission information, and those that do not.

Note: Suppliers may choose not to share commission information; if a supplier does not return displayable information, they may still provide commissions. Refer to the supplier for further information regarding commissions in the event the showing of commissions is suppressed.

To request this, enter "true":

<RateQualifier Commission="true">

@RateAssured

Used to request only suppliers that return the best publicly available rates currently offered. If this field is omitted, the response will contain responses from both suppliers that return RateAssured information, and those that do not.

Note: Suppliers may choose not to share the rate assured indicator. Refer to the supplier for further information regarding rate assured information.

To request this, enter "true":

<RateQualifier RateAssured="true">
@RateCode

Optional

The 2-6 alpha numeric code tied to a special rate for the chosen supplier. When entering this value, the 2 alpha car supplier code must preface this value.

Note: This data may be repeated up to 50 times.

To request, enter the car supplier code followed by the rate code:

<RateQualifier RateCode=”XXABC123,YYDEF456”>

@RateCategory

Optional

Used to request types of rate. For example, if requesting a government rate, enter "G". Can be:

"S", "P", "G", "A", "I", "C", "U", "B", "V", "R", "K", "L", "N"

Note: Most category rates now use more detailed identifers that are used in the RateQualifier children fields. As a best practice, use the children fields to narrow down the request.

To request this, enter one of the category codes listed above:

<RateQualifier RateCatagory=”G”>

@RatePlan

Optional

Used to request the length of rental rates. Can be:

"D" (daily), "E" (weekend), "W" (weekly), and "M" (monthly)

Notes:

  • Most plans are determined by the length of the car rental in days and hours, and outline the difference between the pickup date/time and the return date/time. Because of this, this field tends to rarely be used.
  • If using this attribute, it will force a 5 day long rental to be returned as a "D" (daily) plan instead of defaulting to a "W" (weekly) plan that a car supplier would normally return. This is for business travelers that are not sure how long they will rent the car.

To request this, enter one of the category codes listed above:

<RateQualifier RateCatagory=”D”>

Children

The RateQualifier children are more complex qualifiers of the RateQualifier element:

Note: These items are only entered if the requestor knows this information. Otherwise, leave these fields blank.

Name
Description
//GuaranteePrepaid

Optional

Used when requesting a relatively new type of rate from car suppliers. These rates provide detailed information of refundable amounts during payment at the time of booking.

The following fields are optional, and return Enhanced Guarantee Required or Prepay rates from participating car suppliers. If no values are entered into the request, all types of rates will be returned, with regular retail rates being the most common:

//GuaranteePrepaid/@ReturnPrepaidRates

//GuaranteePrepaid/@ReturnGuaranteeRates

//GuaranteePrepaid/@ReturnRegularRates

<GuaranteePrepaid ReturnPrepaidRates=" "/>
<GuaranteePrepaid ReturnGuaranteeRates=" "/>
<GuaranteePrepaid ReturnRegularRates=" "/>

To request prepaid rates, enter:

<RateQualifier>
    <GuaranteePrepaid ReturnPrepaidRates=”true” />
</RateQualifier>

To request guaranteed rates, enter:

<RateQualifier>
    <GuaranteePrepaid ReturnGuaranteeRates=”true”/>
</RateQualifier>

To request retail rates, enter:

<RateQualifier>
    <GuaranteePrepaid ReturnRegularRates=”true” />
</RateQualifier>

To request both prepaid and guaranteed rates, enter:

<RateQualifier>
    <GuaranteePrepaid ReturnPrepaidRates=”true” ReturnGuaranteeRates=”true”/>
</RateQualifier>

These may be combined into one request:

<RateQualifier>
    <GuaranteePrepaid ReturnPrepaidRates=”true” ReturnGuaranteeRates=”true” ReturnRegularRates=”true”/>
</RateQualifier>

//Corporate/ID

Optional

A car supplier-specific 1-25 alpha numeric code that is used to identify the customer (usually a company) to the car supplier for a corporate discount. This is preceeded by a 2 alpha car supplier code.

Enter the applicable car supplier code and corporate discount number:

<RateQualifier>
    <Corporate><ID>XXABC123,YYDEF456</ID></Corporate>
</RateQualifier>

Note: This data may be repeated for each car supplier, with a limit of 50.

//Promotion/Code

Optional

A car supplier-specific 1-10 alpha numeric code that is used to identify a promotional coupon the customer may use.

Enter the car supplier code and promotional coupon number:

<RateQualifier>
    <Promotion><Code>XXABC123,YYDEF456</Code></Promotion>
</RateQualifier>

Note: This data may be repeated for each car supplier, with a limit of 50.

//TourCode/Text

Optional

A car supplier-specific 1-25 alpha numeric code used to identify the customer to the car supplier for a tour discount.

Enter car supplier code and the applicable tour number:

<RateQualifier>
    <TourCode><Text>XXABC123,YYDEF456</Text></TourCode>
</RateQualifier>

Note: This data may be repeated for each car supplier, with a limit of 50.

//ID/Number

Optional

A car supplier-specific 1-25 alpha numeric code that is used to identify the customer to the car supplier. This is usually the loyalty number of the car supplier, and is similar to a frequent flyer number in the airline industry.

Enter the car supplier code and applicable identity number:

<RateQualifier>
    <ID><Number>XXABC123,YYDEF456</Number></ID>
</RateQualifier>

Note: This data may be repeated for each car supplier, with a limit of 50.

RateQualifier Examples

All attributes and children of the RateQualifier element should be combined as follows:

<RateQualifier CurrencyCode=" " Commission="true" RateAssured="true" RateCode="XX1234,YY5678" RateCategory="G" RatePlan="D">
    <GuaranteePrepaid ReturnPrepaidRates=”true” ReturnGuaranteeRates=”true” ReturnRegularRates=”true"/>
    <Corporate><ID>XXABC123,YYDEF456</ID></Corporate>
    <Promotion><Code>XXABC123,YY7890PC</Code></Promotion>
    <TourCode><Text>XXTOUR2468,YY1357USA</Text></TourCode>
    <ID><Number>XXID02468,YY013557ID</Number></ID>
</RateQualifier>

 

/VehAvailRQCore/SpecialEquipPrefs/SpecialEquipPref/@EquipType

Special equipment such as child seats, bicycle racks, and more. Refer to the Car Matrices page for a list of all values to enter into this field.

Enter the appropriate equipment type:

<SpecialEquipPrefs>
    <SpecialEquipPref EquipType="CST"/>
    <SpecialEquipPref EquipType="NAV">
</SpecialEquipPrefs>

 

/VehAvailRQCore/VehPrefs/VehPref/VehType

Vehicle Preferences are used to specify the type of car(s) to include in the search. For a list of all Vehicle Preferences codes, refer to the Car Matrices page.

Notes:

  • Up to 10 car types may be entered in the request.
  • If no values are entered, the value is defaulted to "ACAR" for All Cartypes. "ACAR" varies by suppliers, but generally includes all 2-4 door cars including minivans and SUVs.
  • Suppliers may choose not to have the ACAR value return all vehicles available for that specific supplier.

To request this, enter the applicable vehicle types:

<RateQualifier>
    <VehPrefs>
        <VehPref>
            <VehType>SCAR</VehType>
            <VehType>LCAR</VehType>
        </VehPref>
    </VehPrefs>
</RateQualifier>

 

/VehAvailRQCore/VehRentalCore

The Vehicle Rental Core element contains attributes and child elements. If child elements are used, this element must end with </VehRentalCore>.

Attributes

Name
Description

@PickUpDateTime

Required

The car pickup date and time in "month-dayTtime" format.

@ReturnDateTime

Required

The car return date and time in "month-dayTtime" format.

To request a car pickup and return date, enter the dates for both in month-dayTtime format:

<VehRentalCore PickUpDateTime="03-010T10:00" ReturnDateTime="03-07T17:00">

Children

VehRentalCore children elements contain pickup city code information (mandatory), and return/drop off city codes (optional). Return/drop off city information is only entered if different than the pickup city code information.

VehRentalCore children are required if the pick up location is using the airport code as the point of search. Otherwise, location details must contain the pick up or drop off location search parameters.

Important! If the search is specifically for airport supported locations, then the OTA_VehAvailRateLLS API should be used. If the search is for finding locations near the airport that may or may not contain airport supported locations, this is the correct API.

Name
Description

//PickUpLocation/@LocationCode

Required

Used to designate the car pickup location by airport code or non-airport code.

Airport Code

A 3 letter alpha-numeric code designates that the pickup location is within an airport.

<PickUpLocation LocationCode="DFW"/>

Note: Only airport locations are allowed for Shop requests. Non-airport codes will be rejected.

Non-Airport Code

A non-airport code designates that the pickup location is outside of an airport. This is shown as a 3 letter alpha-numeric value, followed by an additional alpha and 1-3 numerics. The additional alpha designates the non-airport type by direction or specific code. These values can be:

  • "N": North
  • "S": South
  • "E": East
  • "W": West
  • "R": Resort
  • "X": Rail
  • "P": Port
  • "C": City
<PickUpLocation LocationCode="DFWC001"/>

//ReturnLocation/@LocationCode

Optional

Used to designate the car pickup location by airport code or non-airport code.

Important! This field should only be used if different than //PickUpLocation/@LocationCode above.

Airport Code

A 3 letter alpha-numeric code designates that the return location is within an airport.

<ReturnLocation LocationCode="DFW"/>
Non-Airport Code

A non-airport code designates that the return location is outside of an airport. This is shown as a 3 letter alpha-numeric value, followed by an additional alpha and 1-3 numerics. The additional alpha designates the non-airport type by direction or specific code. These values can be:

  • "N": North
  • "S": South
  • "E": East
  • "W": West
  • "R": Resort
  • "X": Rail
  • "P": Port
  • "C": City
<ReturnLocation LocationCode="DFWC001"/>
//VendorPrefs/VendorPref/@Code

Optional

The 2 alpha code tied to the car supplier requested.

If no suppliers are entered, all car suppliers for the location will be in the request. This value may be repeated up to 50 times.

To request specific car suppliers, enter a valid car supplier code:

<VendorPrefs>
    <VendorPref Code=”XX“/>
    <VendorPref Code=”YY“/>
    <VendorPref Code=”ZZ“/>
    <VendorPref Code=”AA“/>
    <VendorPref Code=”BB“/>
</VendorPrefs>

To exclude certain car suppliers, enter:

<VendorPrefs Exclude="true"><VendorPref Code="XX"/>

This includes all vendors except the excluded.

The Vehicle Rental Core attributes and children should be combined in the request as follows:

When pickup and return values are the same, enter:

<VehRentalCore PickUpDateTime="03-010T10:00" ReturnDateTime="03-07T17:00">
    <PickUpLocation LocationCode="DFW"/>
</VehRentalCore>

When pickup and return are different (one-way), enter:

<VehRentalCore PickUpDateTime="03-010T10:00" ReturnDateTime="03-07T17:00">
    <PickUpLocation LocationCode="DFWN002/>
    <ReturnLocation LocationCode="DFWC001"/>
</VehRentalCore>

Response Sample

<VehLocationFinderRS>
    <VehAvailRSCore>
        <VehRentalCore NumDays="21" NumHours="0" PickUpDateTime="02-02T12:00" ReturnDateTime="02-23T12:00"/>
        <VehVendorAvails>
            <VehVendorAvail RPH="1">
            <DropOffLocationDetails LocationCode="DAL" LocationName="LOVE FIELD, DALLAS" LocationOwner="C">
                <Address>
                    <CityName>DALLAS</CityName>
                    <CountryCode>US</CountryCode>                       
                    <StateProv StateCode="TX"/>
                    <StreetNmbr>7366 CEDAR SPRINGS RD</StreetNmbr>
                </Address>
                <OperationSchedule>
                    <OperationTimes>
                        <OperationTime End="23:30" Start="05:00"/>
                    </OperationTimes>
                </OperationSchedule>
            </DropOffLocationDetails>
            <LocationDetails CounterLocation="A" Direction="S" Distance="2.7" LocationCode="DFW" LocationName="DFWDFW DALLAS FORT WORTH A" LocationOwner="C" UnitOfMeasure="MI">
                <Address Latitude="32.851234" Longitude="-97.035432">
                    <CityName>DALLAS</CityName>
                    <CountryCode>US</CountryCode>
                    <StateProv StateCode="TX"/>
                    <StreetNmbr>2424 EAST 38TH STREET</StreetNmbr>
                </Address>
                <OperationSchedule>
                    <OperationTimes>
                        <OperationTime End="23:59" Start="00:00"/>
                    </OperationTimes>
                </OperationSchedule>
            </LocationDetails>
            <VehAvailCore RPH="1">
                <GuaranteePrepaid Amount="574.87" AmountPercentage="M" CurrencyCode="USD" Ind="P">
                    <CancellationRefundAmount NumDays="0">574.87</CancellationRefundAmount>
                    <CancellationRefundAmount NumDays="1">100.00</CancellationRefundAmount>
                    <CancellationRefundAmount NumDays="331">50.00</CancellationRefundAmount>
                </GuaranteePrepaid>
                <PricedEquip>
                    <SpecialEquipment Code="NAV" Status="CNF">
                        <Rate BaseAmount="169.90" Plan="B"/>
                    </SpecialEquipment>
                </PricedEquip>
                <RentalRate AvailabilityStatus="S" RateCode="ABC123" ReturnOfRate="1" STM_RatePlan="M">
                    <Vehicle>
                        <VehType>ICAR</VehType>
                    </Vehicle>
                </RentalRate>
                <VehicleCharges>
                    <VehicleCharge Amount="900.00" CurrencyCode="USD" GuaranteeInd="G">
                        <AdditionalDayHour>
                            <Day CurrencyCode="USD" MileageAllowance="UNL" Rate="50.00"/>
                            <Hour CurrencyCode="USD" MileageAllowance="UNL" Rate="25.00"/>
                        </AdditionalDayHour>
                        <DropOffCharge Amount="35.84" CurrencyCode="USD"/>
                        <Mileage Allowance="UNL" CurrencyCode="USD" ExtraMileageCharge=".00" Total="UNL" UnitOfMeasure="MI"/>
                        <SpecialEquipTotalCharge CurrencyCode="USD"/>
                        <TotalCharge Amount="1355.02" CurrencyCode="USD"/>
                    </VehicleCharge>
                </VehicleCharges>
            </VehAvailCore>
            <Vendor Code="YY" CompanyShortName="TESTRENT" ParticipationLevel="B"/>
            </VehVendorAvail>
        </VehVendorAvails>
    </VehAvailRSCore>
</VehLocationFinderRS>

Response Elements

/VehAvailRSCore

This element signals the beginning of the Vehicle Location Finder response.

.../VehRentalCore

This element is the beginning of critical information relating to the booking.

Attributes

Name
Description
@NumDays

The length of the rental in days. Will always be a 1-3 numeric value.

Note: A day is defined as the 24-hour period of time based on when the car was picked up.

@NumHours

The number of hours past a 24-hour time period for the length of the rental. Will always be a 1-3 numeric value.

@PickUpDateTime

The pick up time in "month-dayTtime" format.

@ReturnDateTime The return time in "month-dayTtime" format.
Example

<VehRentalCore NumDays="5" NumHours="0" PickUpDateTime="03-01T13:00" ReturnDateTime="03-06T13:00">

.../VehVendorAvails

Contains rate and location information for each car available.

...VehVendorAvails/VehVendorAvail/@RPH

The line number (the count) of each car type/rate in the response.

.../VehVendorAvails/DropOffLocationDetails

This element contains a string of attributes and children elements relating to rental location details. This element is only present if ReturnLocation Details were entered in the request.

Attributes

Name
Description
@ExtendedLocationCode

An optional, non-airport locations only attribute in response to ReturnLocation LocationCode. It's displayed in 1 alpha 3 numeric format, with the 1 alpha representing the type of non-airport by direction or type code. Can be:

  • "N": North
  • "S": South
  • "E": East
  • "W": West
  • "R": Resort
  • "X": Rail
  • "P": Port
  • "C": City
@LocationCode

The 3 alpha-numeric airport code of the pickup location.

@LocationName

The name of the pickup location. Can be 1-26 characters.

@LocationOwner

A 1 alpha value that denotes the owner type of the location. Can be:

"C" for a corporate-owned location, or "F" for a franchise-owned location

Example

<DropOffLocationDetails LocationCode="DAL" LocationName="DFWDFW DALLAS FORT WORTH A" LocationOwner="C">

.../VehVendorAvails/DropOffLocationDetails/Address

This is the beginning of the Address element, which displays when DropOffLocationDetails is present.

Children

Name
Description
//CityName

The name of the city where the return facility is located.

<CityName>DALLAS</CityName>
//CountryCode

The two-digit ISO country code where the return facility is located.

<CountryCode>US</CountryCode>
//StateProv/@StateCode

The state or province code where the return facility is located.

<StateProv StateCode="TX"/>
//StreetNmbr

The street number where the return facility is located.

<StreetNmbr>7366 CEDAR SPRINGS RD</StreetNmbr>
Example

<Address>
    <CityName>DALLAS</CityName>
    <CountryCode>US</CountryCode>
    <StateProv StateCode="TX"/>
    <StreetNmbr>7366 CEDAR SPRINGS RD</StreetNmbr>
</Address>

.../VehVendorAvails/DropOffLocationDetails/OperationSchedule

Contains the operation schedule of the return facility, and may include 1-4 hours of operations.

Children

Name
Description
//OperationTimes

Contains the start and end times of the hours of operation. The operation time of day is always based on the specific day. For example, a location open from 6:00am to 1:00am every day of the week would display as two sets of time:

<OperationTime End="01:00" Start="00:00"/>
<OperationTime End="23:59" Start="06:00"/>
//OperationTime/@End

The closing time of the facility in 24-hour format from 00:00 to 23:59.

//OperationTime/@Start

The opening time of the facility in 24-hour format from 00:00 to 23:59.

Example

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

.../VehVendorAvails/LocationDetails

The LocationDetail attributes and child elements provide specific information pertaining to the location.

Attributes

Name
Description
@CounterLocation Displays 1 alpha numeric value that signifies the location of the rental facility. Can be:
  • "N": NON AIRPORT LOCATION
  • "I": IN TERMINAL
  • "F": OFF AIRPORT/RENTAL SHUTTLE
  • "S": IN TERMINAL/RENTAL SHUTTLE
  • "O": ON AIRPORT/RENTAL SHUTTLE
  • "A": ON AIRPORT/AIRPORT SHUTTLE
  • "C": CALL FOR SHUTTLE
  • "M": 2 SHUTTLES AIRPORT AND RENTAL

If ExtendedLocation is present, CounterLocation is always "N".

@Direction

The direction of the facility from the airport. Can be:

  • "N": North
  • "S": South
  • "E": East
  • "W": West
  • "NE": Northeast
  • "NW": Northwest
  • "SE": Southeast
  • "SW": Southwest
The direction of "NA", Not Applicable, means the latitude and longitude are not exact.
@Distance

The distance of the facility from the airport.

The only time this attribute is empty is when Direction contains "NA".

@ExtendedLocationCode

The Extended Location Code is displayed in a 1 alpha, 3 numeric format, with the 1 alpha representing the type of non-airport by direction or type code. These values can be:

  • "N": North
  • "S": South
  • "E": East
  • "W": West
  • "R": Resort
  • "X": Rail
  • "P": Port
  • "C": City

Example:

<DropOffLocationDetails ExtendedLocationCode="C001"/>

@LocationCode The 3-alpha pickup location code.
@LocationName The 1-26 character name of the pickup location.
@LocationOwner

A single alpha value denoting the type of location. Can be:

  • "C": Corporate owned location
  • "F": Franchise owned location
@UnitOfMeasure The unit of measure in "MI" miles, or "KM" kilometers.
Example

<LocationDetails CounterLocation="A" Direction="S" Distance="2.7" LocationCode="DFW" LocationName="DFWDFW DALLAS FORT WORTH A" LocationOwner="C" UnitOfMeasure="MI">

Children

Name
Description
//Address Signifies the beginning of pickup location information.
//Address/@Latitude

The latitude of the pickup location.

Note: Latitude or longitude will not display if the Direction is "NA". They are only approximate coordinates.

//Address/@Longitude

The longitude of the pickup location.

Note: Latitude or longitude will not display if the Direction is "NA". They are only approximate coordinates.

//Address/CityName

The name of the city where the pickup facility is located.

<CityName>DALLAS</CityName>
//Address/CountryCode

The two-digit ISO country code where the pickup facility is located.

<CountryCode>US</CountryCode>
//Address/StateProv/@StateCode

The state or province code where the return facility is located.

<StateProv StateCode="TX"/>
//Address/StreetNumber

The street number where the return facility is located.

<StreetNmbr>7366 CEDAR SPRINGS RD</StreetNmbr>
//OperationSchedule Contains between 1-4 different hours of operation.
//OperationSchedule/OperationTimes

Contains the start and end times of the hours of operation. The operation time of day is always based on the specific day. For example, a location open from 6:00am to 1:00am every day of the week would display as two sets of time:

<OperationTime End="01:00" Start="00:00"/>
<OperationTime End="23:59" Start="06:00"/>
//OperationSchedule/OperationTimes/OperationTime/@End

The closing time of the facility in 24-hour format from 00:00 to 23:59.

//OperationSchedule/OperationTimes/OperationTime/@Start

The opening time of the facility in 24-hour format from 00:00 to 23:59.

Address Example

<Address Latitude="32.851234" Longitude="-97.035432">
    <CityName>DALLAS</CityName>
    <CountryCode>US</CountryCode>
    <StateProv StateCode="TX"/>
    <StreetNmbr>2424 EAST 38TH STREET</StreetNmbr>
</Address>

Operation Schedule Example

<OperationSchedule>
    <OperationTimes>
        <OperationTime End="01:00" Start="00:00"/>
        <OperationTime End="23:59" Start="06:00"/>
    </OperationTimes>
</OperationSchedule>

.../VehVendorAvails/VehVendorCore/@RPH

This element signals the beginning of the car information, and contains a single @RPH attribute.

The @RPH attribute represents the line number of each rate item.

.../VehVendorAvails/VehVendorCore/GuaranteePrepaid

//GuranteePrepaid contains a string of attributes and child elements. These attributes and children elements return amount information and whether the amount is prepaid or guaranteed.

The response is displayed in sequential order. In the case of multiple //CancellationRefundAmount> values, the number of days will always be in decreasing order:

<GuaranteePrepaid Amount="379.28" AmountPercentage="M" CurrencyCode="USD" Ind="P"> 
    <CancellationRefundAmount NumDays="331">25.00</CancellationRefundAmount> 
    <CancellationRefundAmount NumDays="2">50.00</CancellationRefundAmount>
    <CancellationRefundAmount NumDays="1">100.00</CancellationRefundAmount> 
    <CancellationRefundAmount NumDays="0">379.28</CancellationRefundAmount> 
</GuaranteePrepaid>

Attributes

Name
Description

@Amount

The total amount guaranteed to be charged at time of pickup, even if the customer fails to arrive. This can also be the total amount to be prepaid at the time of booking.

Can be a 1-13 numeric value or up to 12 with one decimal point.

@AmountPercentage

Can be "M" for Money, or "P" for percentage. 

@CurrencyCode

The 3 letter ISO 4217 currency code.

@Ind

Indicator denoting whether the value is Guaranteed "G", or Prepaid "P".

//GuaranteePrepaid can be strung together as follows:

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

Children

GuaranteePrepaid child elements must have at least 1, and up to 4, occurrences of CancellationRefundAmount elements.

Name
Description

//CancellationRefundAmount

Contains one attribute plus one monetary amount or percentage amount. The amount is always a cancellation amount as there is no longer a refund listed.

The refund is the difference between the amount in //GuaranteePrepaid Amount and the @Amount if @Ind="G", or the remaining percentage if @Ind="P".

//CancellationRefundAmount/@NumDays

The number of days covering the entire amount of time from the booking date/time through to the pickup date/time.

This value is between 1-3 numeric, and cannot exceed 331 days.

00.00 (monetary value)

The monetary value or percentage of the cancellation amount.

If <Ind="M">, the value is 1-13 numeric or up to 12 with one decimal point.

If <Ind="P">, the value is 1-5 numeric, with no more than 3 numbers to the right of a single decimal point.

//GuaranteePrepaid child elements can be strung together as follows:

<CancellationRefundAmount NumDays="2">50.00</CancellationRefundAmount>
<CancellationRefundAmount NumDays="1">100.00</CancellationRefundAmount>
<CancellationRefundAmount NumDays="0">379.28</CancellationRefundAmount>

.../VehVendorAvails/VehVendorCore/PricedEquip

This element is optional, but when present, contains the //SpecialEquipment and //Rate/@BaseAmount elements.

.../VehVendorAvail/VehAvailCore/PricedEquip/SpecialEquipment

SpecialEquipment attributes display if //PricedEquip is present. These attributes are commonly referred to as Car Extras, and may return physical equipment, services, and surcharges.

Attributes

Name
Description

@Code

Displays when //PricedEquip is present in the response, and includes things like child seats, services, and surcharges. These codes can be standard Sabre Car Codes, or custom codes provided by the supplier. These car supplier codes do not have a defined name returned, as they are defined in the Sabre Car Rental Location Policy.

Special equipment/Car Extra codes may be repeated up to 10 times. Some suppliers do not support this field, or only support up to 4-10 repeats of equipment type.

Refer to the Matrices page for a full list of Car Extra codes.

@Status

Displays when //PricedEquip is present in the response. Can be Confirmed "CNF", On Request "ONR", or Not Available "NTA".

Children

Name
Description

//Rate

Contains two attributes contains the amount of the Car Extra(s) and the plan type applied to the amount.

//Rate/@BaseAmount

Displays when <PricedEquip> is present, and contains the base amount of the Car Extra.

//Rate/@Plan Displays when <PricedEquip> is present, and contains the plan type to apply to the amount. Can be Daily "D", Weekend "E", Weekly "W", Monthly "M", and Bundled "B".

.../VehVendorAvail/VehAvailCore/RentalRate

Attributes

Name
Description
//Vehicle Signals the beginning of vehicle type, monetary amounts, and distance limits (if applicable).

//Vehicle/VehType

A 4 alpha-numeric code that denotes the type of vehicle. Refer to the Matrices page for a list of all possible values.

Example

<RentalRate AvailabilityStatus="S" RateCode="ABC123" STM_RatePlan="W">

Children

Name
Description

//Vehicle

Denotes the beginning of the vehicle type information, monetary amounts, and distance limits (if any).

//Vehicle/VehicleType

A 4 alpha-numeric code that denotes the type of vehicle. Refer to the Matrices page for a list of all possible values.

.../VehVendorAvail/VehAvailCore/VehicleCharges

VehicleCharges contains all information regarding car rental pricing.

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge

Attributes

Name
Description

@Amount

The base amount, can be a 1-13 numeric value, or up to 12 with one decimal point.

@CurrencyCode

The 3 letter ISO 4217 currency code.

@GuaranteeInd

The Guarantee Indication has a dual purpose:

  • The primary purpose displays whether the rate is guranteed. This is a one letter value that can be Guarantee "G", Request (Quoted) "Q", or Closed "C".
  • The secondary purpose indicates the rate in the Amount=" " is the actual amount or has been converted from the specific currency of the rental location. If present, this value will be prior to the "G", "Q", or "C", and the value will be a cross Loraine, representing change (‡).

<VehicleCharge Amount="426.24" CurrencyCode="GBP" GuaranteeInd="‡G">

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/AdditionalDayHour

Represents the beginning of an extra day and any extra hourly rates/mileages. When this field displays, at least one child element will also display describing the overage(s).

<AdditionalDayHour>
    <Day CurrencyCode="GBP" MileageAllowance="UNL" Rate="71.04"/>
    <Hour CurrencyCode="GBP" MileageAllowance="UNL" Rate="10.04"/>
</AdditionalDayHour>

Day Attributes

Name
Description

//Day

Lists all attributes that apply to the extra day.

//Day/@CurrencyCode

The 3 letter ISO 4217 currency code.

//Day/@MileageAllowance

Denotes the limit of distance allowed for an the extra day of rental. Can be "UNL" for Unlimited or a 1-5 numeric value.

Note: If MileageAllowance="UNL", then the extra day must be UNL.

//Day/@Rate

Displays the rate of the extra day. Can be a 1-13 numeric value or up to 12 with one decimal point.

<Day CurrencyCode="GBP" MileageAllowance="UNL" Rate="71.04"/>

Hour Attributes

Name
Description

//Hour

Lists all attributes that apply to the extra hour.

//Hour/@CurrencyCode

The 3 letter ISO 4217 currency code.

//Hour/@MileageAllowance

Denotes the limit of distance allowed for an the extra hour of rental. Can be "UNL" for Unlimited or a 1-5 numeric value.

Note: If MileageAllowance="UNL", then the extra day must be UNL.

//Hour/@Rate

The rate of the extra hour. Can be a 1-13 numeric value or up to 12 with one decimal point.

<Hour CurrencyCode="GBP" MileageAllowance="UNL" Rate="15.04"/>

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/DropOffCharge

Displays attributes only when DropOffLocationDetails is present.

Attributes

Name
Description

@Amount

Denotes the car rental drop off amount. Can be a 1-13 numeric value, or up to 12 with one decimal point.

@CurrencyCode

The 3 letter ISO 4217 currency code.

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/Mileage

Displays details pertaining to the distance limit of the rental and extra mileage fees.

Attributes

Name
Description

@Allowance

The limit of distance allowed for the plan. Can be "UNL" for unlimted or a 1-5 numeric value.

@CurrencyCode

The 3 letter ISO 4217 currency code.

@ExtraMileageCharge

  • If Allowance="UNL", then ExtraMileageCharge=".00"
  • This charge will display a 1-5 numeric value if the Allowance=" " is a numeric value.

@UnitOfMeasure

The unit of measure in either Miles "MI" or Kilometer "KM".

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/SpecialEquipTotalCharge/@CurrencyCode

Contains a number of attributes when the currency code is the only one present and no //PricedEquip is present.

.../VehVendorAvail/VehAvailCore/VehicleCharges/VehicleCharge/TotalCharge

Contains the total charge of the car rental and the currency of the charge.

Attributes

Name
Description

@Amount

Denotes the total amount of the car rental. Can be a 1-13 numeric value, or up to 12 with one decimal point.

@CurrencyCode

The 3 letter ISO 4217 currency code.

<TotalCharge Amount="1017.20" CurrencyCode="GBP"/>

Docs Navigation