Vehicle Rules

Vehicle Rules obtain additional information regarding conditions and charges associated with vehicle rentals. Rate rules can be requested:

• After a Vehicle Search when rules are requested for selected search response.

• After a Vehicle Booking using the booking confirmation number.

Vehicle Rules are also returned as part of the standard Vehicle Booking response. These rules can vary by supplier, but typically include:

• Base rate detail

• Applicable drop charges

• Applicable surcharges or fees

• The cost of insurance coverage available

• Acceptable credit cards

• Pick-up and return station hours

• Special Equipment

• Prepayment cancellation advisory rules (1P Only)

A rules request should be made before booking to confirm the terms of the rental. If the traveler fails to adhere to these rules and restrictions, the supplier can assess penalties or revert the rates from discounted to standard. However, a rules request can also be from a sold segment.

Request

VehicleRulesReq in the Vehicle Service is used to request location details.

Show schema diagram

Vehicle Rules after Vehicle Search

To request Vehicle Rules after a Vehicle Search, the following data is required in the VehicleRulesLookup children VehicleDateLocation and Vehicle Search Modifiers: 

• Pick-up date and time

• Return date and time

• Pick-up location   

• Tour Code

  A tour code is issued by an airline to identify the relationship between an air booking and a vehicle booking that are purchased together as a package. The tour code must be shown on the ticket so that both the airline and the local BSP or ARC know what the fare is, and that the agency has authority to use it.

  Notes:

  • The code may have a maximum of 13 alpha/numeric characters that will show on the ticket.
  • Worldspan (1P) Only.

• Vehicle modifier information (AirConditioning, TransmissionType, VehicleClass, and Category)

• Supplier (Vendor) code

• RateHostIndicator and RateToken should be in the vehicle rules request when returned in the availability response. Without these values, requests may return an error for some vendors.

• Rate modifier information (RateCode and RateCategory)

  • RateCategroy and RatePeriod should be present in the VehicleRules request when returned in the VehicleSearchAvailability response.

Note: The Return location is optional in the request. If it is not included, the return location is assumed to be the same as the pick-up location.   

To request Vehicle Rules for a booked segment, the VehicleReservationLocatorCode is required. If no BookingConfirmation is sent in the response, a warning is sent: "Vehicle Rules returned are as of today since Vehicle supplier confirmation is not yet available".

Promotional Codes and Coupon Numbers

Universal API supports Promotional Codes/Coupon Numbers added to Vehicle Rules. The Vehicle Rules response shows the discounted rate if the supplier accepted the coupon.

If a Promotional Coupon is used, the Promotional category is not returned response unless a Promotional rate category is requested. The category in the request is passed to the suppliers (vendors), but they are not required to send a category back in their response to Travelport. Suppliers frequently ignore the category sent, and sends the best rates that apply for the rental period and all search parameters.

The Promotional Code and Coupon Numbers are requested via VehicleRulesLookup/VehicleSearchModifiers/RateModifiers @PromotionalCode and displayed in the response at VehicleRulesRsp/Vehicle/VehicleRate/SupplierRate @DiscountAmount.

Response

VehicleRulesRsp returns rules.

Show schema diagram

The amount and type of information returned varies by supplier and provider, but typically includes:

• Pick-up hours of operation

• Return hours of operation

• Vehicle supplier (vendor)

• Vehicle modifiers

• Estimated base rate

• Approximate total amount

• Rate amount

• Rate modifiers

• Rate code

• Rate category

  • To allow car suppliers the ability to offer different rates for prepaid bookings, the RateCategory, “Prepay” is supported in all Universal API Vehicle transactions.

    • Adding the Rate Category “Prepay” to the request message indicates to the supplier that you want these particular rate plans included in the response.

    • The ability to get prepay information in the response is supplier dependent.

  • @RateCategory="Prepay" is a part of

    • /VehicleSearchModifiers in
      • VehicleSearchAvailabilityReq
      • VehicleRulesReq
    • /Vehicle/VehicleRate in
      • VehicleSearchAvailabilityRsp
      • VehicleRulesRsp
      • VehicleCreateReservationReq

• Base rate includes

• Approximate total includes

• Mileage allowance

• Mileage rate

• Extra days/hours charge

• Drop-off charges
  VehicleRulesRsp/Vehicle/VehicleRate/SupplierRate @DropOffCharge

• Advanced Booking (The Number of Days or Hours in advance that the displayed Car must be booked for the returned rate) for 1P in
  VehicleRulesRsp/Vehicle/VehicleRate@AdvancedBooking

• Flight Restrictions ( Indicates flight information is required at booking) FOR 1P in .
  VehicleRulesRsp/Vehicle/VehicleRate@FlightRestriction
• Taxes
  VehicleRulesRsp/Vehicle/VehicleCharge @Category="Tax"

• Surcharges
  VehicleRulesRsp/Vehicle/VehicleCharge @Category="Surcharge"

• Coverages
  VehicleRulesRsp/Vehicle/VehicleCharge @Category="Coverage"

• Special Equipment (Worldspan Only)
  VehicleRulesRsp/Vehicle/VehicleCharge @Category="Special"
  Note: Universal API populates the @Name attribute with the Special Equipment string code enumeration, and adds the @Description optional attribute to describe the special equipment charge.

• Conditional Fees (Worldspan Only)
  VehicleRulesRsp/Vehicle/VehicleCharge @Category="Conditional"

• Counter Location Code
  VehicleRulesRsp/Vehicle @CounterLocationCode
  Note: This is the four-byte code to identify the Location of the Rental Counter, e.g. OMSO, PHON, etc. Universal API converts the 1G and 1V Counter Location 1-byte value to a 4-byte code, or converts the 1P Counter Location string text to a 4-byte code, in the response

• Accepted forms of payment (credit cards)

• Guarantee rules

• Deposit rules

• Prepayment cancellation rules (Worldspan Only)
  VehicleRulesRsp/PrePayCancelInfo/@Code, @Amount, @Percent, @NumberOfDaysHours, @RentalDays

• Discount amount
• Location
  VehicleRulesRsp/Vehicle@Location
  Note: The Vehicle Rules returns the location of the Shuttle Category code in the description text. For example, "S" code is returned as “Offsite – Shuttle to counter and car” as the Location of Counter description text for the Shuttle Category Code.
• An ACRISS Standard code.

Exceptions

Worldspan

Pickup and Return Location

With Vehicle v32.0, VehicleRulesRsp was updated with the elements /PickupLocationInformation and /ReturnLocationInformation. Each element has the following attributes:

• @LocationName, @CounterLocation, @VendorCode, @LocationCode, @LocationType, @LocationNumber
• /Address/@Street, @State, @Country
• /PhoneNumber/
• /OperationTime/

Note: When the return is to the pickup location the ReturnLocationInformation element is not populated.

Vehicle Date Location

The off-airport rental rate rules display in the @ReturnLocationType and @ReturnLocationNumber attributes for all schema versions (VehicleRulesReq/VehicleRulesLookup/VehicleDateLocation/@ReturnLocationType and @ReturnLocationNumber). When the Return is to the pickup Location, the ReturnLocationInformation element is not populated.

Vehicle Rate

Mandatory Charges

Universal API displays the total for all mandatory charges in the attribute “MandatoryChargeTotalAmount” (VehicleRulesRsp/Vehicle/VehicleRate/SupplierRate@MandatoryChargeTotal). The Total Mandatory Charges may include taxes, surcharges, and fees.

Weekly Late Charge

Previously, Universal API Vehicle Rules Response did not return the Extra Week Charge information, only Hourly Late Charge and Daily Late Charge.

Extra Week Charge information returns in VehicleRulesRsp/Vehicle/VehicleRate/WeeklyLateCharge.

General Text

General Text populates the VehicleRulesRsp/Vehicle/VehicleRate/VehicleRateDescription/@Text attribute, and the /VehicleRateDescription@Name attribute displays “General.” Additionally:

• The word “General<space>-<space>” was previously hard-coded in the @Text attribute before the general text was populated in the same field.
• The VehicleRateDescription maximum occurrence was increased from 1 to 99 to support the different “Name” attributes.

Advisory Messages

Previously, Universal API Vehicle Rules Response returned the “Advisory Text” in the /ResponseMessage element. However, that element is not most relevant place to display the “Advisory Text” data (it is mostly used for error messages).

• When Advisory Text is in the response, the VehicleRateDescription/@Name attribute displays "Advisory" and the associated Advisory Text response populates the VehicleRateDescription/ @Text attribute.
• For Galileo (1G) and Apollo (1V), advisory text still displays in the VehicleRulesRsp/ResponseMessage.

Mileage Restriction

Universal API displays “Mileage Restriction” information in the existing VehicleRulesRsp/Vehicle/VehicleRate/VehicleRateDescription@Text attribute, and the @Name attribute will display "RentalRestriction."

Location Policy Information

• The Vehicle Rules category request allows the user to request “All” vehicle policies, or specific policy categories using RequestPolicyInformation/Policy @Code. Codes are available through Reference Data using the "VehiclePolicy" TypeCode.
• The available Policy information is returned in one or more VehiclePolicyCategoryInformation elements with each policy category uniquely identified in @Name and the policy content returned in @Text.

The following schema modifications support this modification:

• The RequestPolicyInformation child element was added to VehicleRulesReq/VehicleRulesLookup/VehicleSearchModifiers.

• The VehiclePolicyCategoryInformation child element was added to VehicleRulesRsp.

For backward compatibility:

• Previous vehicle schema will continue to request and process GUAR (K) and PKUP (P) Categories as current, returning the data in /RateDescription.
• If GUAR and PKUP are requested in <veh:RequestPolicyInformation>, Universal API will request and return the text in /VehiclePolicyCategoryInformation only.

Guarantee Text

Vehiclereturns the Guarantee text associated to the Guarantee in the Vehicle Rules Response. Guarantee and Rate Guarantee text is populated in the existing attribute “Text” (VehicleRulesRsp/Vehicle/VehicleRate/VehicleRateDescription/Text and @Name=”Guarantee”)

Rate Host Indicator

The Worldspan providers are expanding Travelport’s car database to be able to accept the Open Travel Alliance (OTA) 2014 standard for Search/Reference ID token size. This enhancement modifies /RateHostIndicator @InventoryToken and @RateToken in Vehicle Rules, VehicleSearchAvailabilityRsp, and VehicleCreateReservationReq to support the expansions of the Rate Qualifier node, including the RateAuthorizationCode (expanding 8 Bytes (1-28)) and SequenceNumber (bytes 21-24 moved to 29-32).

Payment Rule

Universal API returns an indicator in the Vehicle Rules Response to indicate whether a Vehicle Rate required Prepayment at booking.

• Universal API returns the Pre-payment Required indicator and the valid Prepayment Credit Card(s).

Payment Guarantee

Universal API returns an indicator in Vehicle Rules Response whether a Vehicle Rate required a Guarantee at booking.

Vehicle

• Returns an Indicator in VehicleRulesRsp for Guarantee Required

  • When the user sends VehicleRulesReq for Vehicle rate with Guarantee required, the result is that VehicleRulesRsp/PaymentRule/@Required is set to “true” and @Purpose is set to “Guarantee”

• Returns the Guarantee Credit Cards in the VehicleRulesRsp

  • When the user sends VehicleRulesReq for Vehicle rate with Guarantee required and valid Credit Cards, the result is that VehicleRulesRsp/PaymentRule/@Required is set to “true”, @Purpose is set to “Guarantee” and /CreditCard is populated

Note: Prepayment, Guarantee, and Deposit Required indicators are mutually exclusive and cannot be returned in combination with one another.

PrePayment Cancellation Information

Universal API returns car Prepayment Cancellation advisory rule values in the PrePayCancelInfo element, with the attributes @Code, @Amount, @Percent, @NumberOfDaysHours, @RentalDays.

Additionally, a car supplier determines and sends one or more coded values and variables that apply to the cancellation policies in effect for a requested Vehicle Rule.

• Each Coded Value has fixed text associated to it that is not returned in the Vehicle Rule response.
• Universal API users need to manage the associated fixed text and display it to their users in the format determined by them.
• To assist in the management of the Coded Values and fixed text, the tables below list all of the Coded Values and associated fixed text along with a sample of the VehicleRules/PrePayCancelInfo:
  • The BLUE shaded rows that follow each Coded Value line are the /PrePayCancelInfo element equivalents returned for this specific item.
  • The bold numbers are the variable(s) for the code Value.
  • The associated text is represented under the Fixed Text column.

 

Coded Value @Code	Fixed Text
901	Cancellation not permitted
<PrePayCancelInfo Code="901"/>
902	Cancellation penalty charges are inclusive of taxes, fees, mandatory surcharges, and any applicable drop charge and optional service fees
<PrePayCancelInfo Code="902"/>

 

Coded Value @Code	@Amount	Fixed Text	@NumberOfDaysHours	FixedText
903	USD10.00	Fee to cancel up to	48	hours prior to pick-up
<PrePayCancelInfo Code="903" Amount="USD10.00" NumberOfDaysHours="048"/>
904	USD25.00	Fee to cancel if less than	12	hours prior to pick-up
<PrePayCancelInfo Code="904" Amount="USD25.00" NumberOfDaysHours="012" />
905	USD50.00	Fee to cancel up to	7	days prior to pick-up
<PrePayCancelInfo Code="905" Amount="USD50.00" NumberOfDaysHours="007"/>
906	USD35.00	Fee to cancel if less than	1	days prior to pick-up
<PrePayCancelInfo Code="906" Amount="USD35.00" NumberOfDaysHours="001" RentalDays="001"/>

 

Coded Value @Code	@Amount	Fixed Text
907	USD75.00	Fee to cancel reservation
<PrePayCancelInfo Code="907" Amount="USD75.00""/>
908	USD100.00	Fee for no show
<PrePayCancelInfo Code="908" Amount="USD100.00"/>

 

Coded Value @Code	@Percent	Fixed Text	@NumberOfDaysHours	FixedText
909	10	Percent prepayment forfeiture to cancel up to	24	hours prior to pick-up
<PrePayCancelInfo Code="909" Percent="" NumberOfDaysHours="024" RentalDays="001"/>
910	100	Percent prepayment forfeiture to cancel less than	24	hours prior to pick-up
<PrePayCancelInfo Code="910" Percent="100" NumberOfDaysHours="024"/>
911	25	Percent prepayment forfeiture to cancel up to	5	days prior to pick-up
<PrePayCancelInfo Code="911" Percent="25" NumberOfDaysHours="005"/>
912	75	Percent prepayment forfeiture to cancel less than	1	days prior to pick-up
<PrePayCancelInfo Code="912" Percent="075" NumberOfDaysHours="001"/>
913	10	Percent rental charge fee to cancel, up to maximum	24	hours rental
<PrePayCancelInfo Code="913" Percent="010" NumberOfDaysHours="024"/>
914	100	Percent rental charge fee to cancel, up to maximum	7	days rental
<PrePayCancelInfo Code="914" Percent="100" NumberOfDaysHours="007"/>

 

Coded Value @Percent	@Amount	Fixed Text
915	50	Percent prepayment forfeiture to cancel
<PrePayCancelInfo Code="915" Percent="050"/>
916	100	Percent prepayment forfeiture for no show
<PrePayCancelInfo Code="914" Percent="100" NumberOfDaysHours="007"/>

 

 

Coded Value @Code	@Rental Days	Fixed Text	@NumberOfDaysHours	FixedText
917	0	Days rental charged to cancel up to	24	hours prior to pick-up
<PrePayCancelInfo Code="917" NumberOfDaysHours="024" RentalDays=”000”/>
918	1	Days rental charged to cancel if less than	12	hours prior to pick-up
<PrePayCancelInfo Code="918" NumberOfDaysHours="001" RentalDays=”012”/>
919	0	Days rental charged to cancel up to	7	days prior to pick-up
<PrePayCancelInfo Code="919" NumberOfDaysHours="000" RentalDays=”007”/>
920	1	Days rental charged to cancel if less than	1	days prior to pick-up
<PrePayCancelInfo Code="920" NumberOfDaysHours="001" RentalDays=”001”/>
921	1	Days rental charged to cancel
<PrePayCancelInfo Code="921" NumberOfDaysHours="001"/>
922	7	Days rental charged for no show
<PrePayCancelInfo Code="922" NumberOfDaysHours="007"/>

 

Coded Value @Code	@RentalDays	Fixed Text	Number	@Amount	Fixed Text	@NumberOfDaysHours	FixedText
923	1	Days rental	Minimum of	USD25.00	Charged to cancel up to	12	hours prior to pick-up
<PrePayCancelInfo Code="923" Amount="USD50.00" NumberOfDaysHours="012" RentalDays="001"/>
924	2	Days rental	Maximum of	USD50.00	Charged to cancel up to	24	hours prior to pick-up
<PrePayCancelInfo Code="924" Amount="USD50.00" NumberOfDaysHours="024" RentalDays="002"/>

 

Coded Value @Code	@RentalDays	Fixed Text	Number	@Amount	Fixed Text	@NumberOfDaysHours	FixedText
925	4	Days rental	Minimum of	USD100.00	Charged to cancel less than	12	hours prior to pick-up
<PrePayCancelInfo Code="925" Amount="USD100.00" NumberOfDaysHours="012" RentalDays="004"/>
926	3	Days rental	Maximum of	USD75.00	Charged to cancel less than	24	hours prior to pick-up
<PrePayCancelInfo Code="926" Amount="USD75.00" NumberOfDaysHours="024" RentalDays="003"/>
927	1	Days rental	Minimum of	USD50.00	Charged to cancel up to	3	days prior to pick-up
<PrePayCancelInfo Code="927" Amount="USD50.00" NumberOfDaysHours="003" RentalDays="001"/>
928	7	Days rental	Maximum of	USD100.00	Charged to cancel up to	1	days prior to pick-up
<PrePayCancelInfo Code="928" Amount="USD100.00" NumberOfDaysHours="001" RentalDays="007"/>
929	1	Days rental	Minimum of	USD25.00	Charged to cancel less than	1	days prior to pick-up
<PrePayCancelInfo Code="929" Amount="USD25.00" NumberOfDaysHours="001" RentalDays="001"/>
930	3	Days rental	Maximum of	USD50.00	Charged to cancel less than	2	days prior to pick-up
<PrePayCancelInfo Code="930" Amount="USD50.00" NumberOfDaysHours="002" RentalDays="003"/>

FD Link

Specific Special Equipment

Currently, Universal API Vehicle Rules supports the ability to request specific Vendor Location policy information including general policy for Special Equipment.

• Universal API Vehicle Rules supports the ability to request specific Special Equipment information via Worldspan and consume the Provider code for specific special equipment information.
• Request and receive Special Equipment information for specific or ALL Special Equipment in its own distinct element and attribute, keeping the current functionality to request Location policy information. See the VehicleSpecialEquipment in Reference Data for all associated codes.

• In the Vehicle Rules Response, the @Name attribute populates with the Special Equipment string code enumeration and may return the @Description optional attribute. The Name attribute identifies the type of charge information for the category. When the category is “Special”, the name attribute has a Special Equipment code enumeration, which can be used in booking vehicles. For example, Name="ToddlerSeat.” The Description attribute displays the special equipment rental charge description. Vehicle special equipment codes and descriptions can be obtained from Reference Data.

Pretty Print Service and Localized/Foreign Language

Vehicle v47.0 allows customers to receive both “Pretty Print” Enhanced English content and Localized/Foreign Language as part of the Vehicle Rules response. Release 18.4

• The foreign language is limited to French Canadian as of Vehicle v47.0.

• If no language is requested, US English is returned.

The following text is enhanced as of Vehicle v47.0:

Vehicle Rule / Policy Term	Enhanced "Pretty Print" and Localized term
AGE	Age Requirements
CDW	Collision Damage Waiver
CRED	Credit Card Information for Guarantees / Deposits
DROP	Drop-Off Charges
GAS	Refueling Requirements on Return
INS	Insurance
OTHER	Miscellaneous
PYMT	Acceptable Forms of Payment
TAX	State and Local Tax Information
VALID	Driver License Requirement
PAI	Personal Accident Insurance
ARRIV	Arrival Information
EXPR	Express Service Availability
SHTTL	Shuttle Service Availability
SPRATE	Special Rate