Fare Rules Filter

Fare Rules Filter is currently in Alpha release and available for testing on Galileo (1G)/Apollo (1V). Improved availability for testing in Worldspan (1P) will be forthcoming.

Future enhancements will refine the consistency and reliability of response data from the providers, and clarify if rules apply before or after the start of travel. Until these enhancements, and any associated schema changes, are completed, we recommend waiting to deploy Fare Rules Filter functionality in production.

Please contact your Travelport representative for more information.

Full Fare Rules text is not supported in Low Fare Shopping responses. However, Fare Rules Filter (previously known as Mini-Fare Rules) functionality can be used to return Fare Rule indicators for specified rule categories, which can be displayed in a matrix to provide users with an overview of the rule options available for a specific fare.

A subsequent Air Pricing or Fare Rules request can then be made to obtain the full rules text.

Implementation by Provider

Provider	Implementation
Galileo (1G)	Supports Fare Rules Filter for customers with appropriate provisioning.
Apollo (1V)	Supports Fare Rules Filter for customers with appropriate provisioning.
Worldspan (1P)	Supports Fare Rules Filter for customers with appropriate provisioning.
Airline Content Hub (ACH)	Does not support Fare Rules Filter.
Rail Content Service (RCS)	Does not support Fare Rules Filter.

Request

In a Low Fare Shopping request, send the Fare Rules Filter category code value in LowFareSearch(Async)Req/FareRulesFilterCategory/CategoryCode. The table below describes each value that can be send in the request and the expected information returned in the response.

Request: CategoryCode Value	Description	Response: /AirPricingInfo/FareRulesFilter	Additional Response Data
MIN	Minimum stay fare rules	/MIN attributes: HoursMin indicates minimum hours. If true, the unit of time is hours. If false, the unit of time is not hours. DaysMin indicates minimum days. If true, the unit of time is days. If false, the unit of time is not days. MonthsMin indicates minimum months. If true, the unit of time is months. If false, the unit of time is not months. OccurIndMin indicates minimum concurrence. If true, the day of the week is used. If false, the day of the week is not used. SameDayMin indicates same day minimum. If true, stay is the same day. If false, stay is not the same day. If the minimum unit of time is true, then TmDOWMin indicates the day of the week. A value of 1 indicates Sunday, and a value of 7 indicates Saturday. FareComponent indicates the number of the most restrictive fare. NumOccurMin is used in conjunction with TmDOWMin. For example, if both NumOccurMin and TmDOWMin contain a value of 1, then the minimum stay for this fare is 1 Sunday.
MAX	Minimum stay fare rules	/MAX attributes: HoursMax indicates maximum hours. If true, the unit of time is hours. If false, the unit of time is not hours. DaysMax indicates maximum days. If true, the unit of time is days. If false, the unit of time is not days. MonthsMax indicates maximum months. If true, the unit of time is months. If false, the unit of time is not months. OccurIndMax indicates maximum concurrence. If true, the day of the week is used. If false, the day of the week is not used. SameDayMax indicates same day maximum. If true, stay is the same day. If false, stay is not the same day. StartIndMax is a start indicator. If true, there is a start indicator. If false, there is not a start indicator. CompletionInd is a completion indicator. If true, there is a Completion C indicator. If false, there is not a Completion C indicator. If the maximum unit of time is true, then TmDOWMax indicates the day of the week. A value of 1 indicates Sunday, and a value of 7 indicates Saturday. FareComponent indicates the number of the most restrictive fare. NumOccurMax is used in conjunction with TmDOWMax. For example, if NumOccurMax is 1 and TmDOWMax is 3, then the maximum stay for this fare is 1 (NumOccurMax value) Tuesday (TmDOWMax value).
ADV	Advanced purchase fare rules	/ADV attributes: AdvRsvnOnlyIfTk indicates if advanced reservations are required only if ticketed. If false, no advanced reservations are required. AdvRsvnAnyTm indicates if advanced reservations are available anytime. If false, advanced reservations are available for a limited time. AdvRsvnHrs indicates if the unit of time for advanced reservation is in hours. If false, the unit of time is not hours. AdvRsvnDays indicates if the unit of time for advanced reservation is in days. If false, the unit of time is not days. AdvRsvnMonths indicates if the unit of time for advanced reservation is in months. If false, the unit of time is not months. AdvRsvnEarliestTm indicates if the advanced reservation time is the earliest permitted. AdvRsvnLatestTm indicates the advanced reservation time is the latest permitted. AdvRsvnWaived indicates if the advanced reservation is waived. AdvRsvnDataExists indicates if advanced reservation data exists. AdvRsvnEndItem indicates the reservation end item. If true, more values exist. If false, no more values exist. AdvTkEarliestTm indicates the advanced reservation time is the earliest permitted ticketing time. AdvTkLatestTm indicates the advanced reservation time is the latest permitted ticketing time. AdvTkRsvnHrs indicates that the ticketing reservation unit of time is hours. AdvTkRsvnDays indicates that the ticketing reservation unit of time is days. AdvTkRsvnMonths indicates that the ticketing reservation unit of time is months. AdvTkStartHrs indicates that the advanced ticketing departure time is in hours. AdvTkStartDays indicates that the advanced ticketing departure time is in days. AdvTkStartMonths indicates that the advanced ticketing departure time is in months. AdvTkWaived indicates if advanced ticketing is waived. AdvTkAnyTm indicates if advanced ticketing is allowed anytime. AdvTkEndItem indicates the ticketing end item. If true, more values exist. If false, no more values exist. AdvRsvnTm indicates the advanced reservation time. AdvTkRsvnTm indicates the advanced ticketing reservation time. AdvTkStartTm indicates the advanced ticketing departure time. EarliestRsvnDtPresent indicates if an earliest reservation date is present. EarliestTkDtPresent indicates if an earliest ticketing date is present. LatestRsvnDtPresent indicates if a latest reservation date is present. LatestTkDtPresent indicates if a latest ticketing date is present EarliestRsvnDt indicates the earliest reservation date. EarliestTkDt indicates the earliest ticketing date. LatestRsvnDt indicates the latest reservation date. LatestTkDt indicates the latest ticketing date.
CHG	Refundability for changes and cancellations	/Refundability values: "FullyRefundable" Fully refundable ticket. "RefundableWithPenalty" Refundable ticket with a change or cancellation penalty. Note: This value is only returned for v31 through v33. For v34 and later, an upgrade was implemented that more closely reflects refundability behavior in the Travelport systems. "NonRefundable" Non-refundable ticket. Note: Travelport recommends not hard coding to any strings because additional values may be added in future releases. /CHG attributes: DepRequired indicates that a deposit is required. DepNonRef indicates that the deposit is non-refundable. TkNonRef indicates that the ticket is non-refundable. AirVFee indicates that a carrier fee is assessed if the passenger does not complete all conditions for travel. Cancellation indicates subject to penalty if canceled. FailConfirmSpace indicates subject to penalty if seats are not confirmed. ItinChg indicates subject to penalty if Itinerary is changed requiring reissue of ticket. ReplaceTk indicates subject to penalty if ticket must be replaced if lost or if exchanged. Applicable indicates the amount specified is applicable. If ApplicableTo is true, the amount specified applies to the penalty. If false, the amount specified applies to the deposit. AnytimePenalty indicates that the penalty applies anytime. BeforeDeparturePenalty indicates that the penalty applies before departure. AfterDeparturePenalty indicates that the penalty applies after departure. Amt indicates the amount of the penalty. A format of XXX.XX indicates an amount. A format of XX is a percentage. Type indicates the type of penalty, where D indicates dollar and P indicates percentage. Currency indicates the currency code of the penalty.	If there are change or cancellation penalties, regardless of what the Refundability value is, they are also returned: /AirPricingModifiers/PenaltyFareInformation @ProhibitPenaltyFares /AirPricingModifiers/PenaltyFareInformation/ PenaltyInfo/ Amount /AirPricingModifiers/PenaltyFareInformation/ PenaltyInfo/Percentage
OTH	Other fare rules	The category attributes indicate whether the rules for that category apply. If true, the category rules apply. If false, the category rules do not apply. RestrictiveDt indicates the most restrictive ticketing date. SurchargeAmt indicates the surcharge amount. If NotUSACity is true, then the origin or final destination is not a continental U.S. city. If false, the origin or final destination is a continental U.S. city. If MissingRules is true, rules are missing. If false, no rules are missing.

Response

The response returns filtered Rules for both Air Pricing Solutions and Air Price Points structures. See Implemented Transactions for full Xpaths.

In the Low Fare Shopping response, child elements of /AirPricingInfo/FareRulesFilter that correspond to the requested CategoryCode sent in the request are returned. For example, the Refundability status of the fare.

A subsequent Air Pricing or Fare Rules request can then be made to obtain the full rules text.