API Information

Response Format
XML
Service Action Code
RevalidateItinRQ
Current Version
5.2.0
Target Audience
TN
Environment
Production
Documentation
Go to the Revalidate Itinerary documentation

What's New

  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Shop by Fare Basis Code – project introduces enhancements to our Bargain Finder Max and Revalidate Itinerary API to support the capability for shopping to exclude a fare option based on Fare Basis Code.
  • Shop by – Class of Service – project introduces enhancements to our Bargain Finder Max and Revalidate Itinerary API to support the capability for shopping to exclude a fare option based on Class of Service (RBD).
  • Shop with parity mode – the project introduces enhancements to our Multiple Branded Fare shopping capabilities that allows to control the parity mode also for the lowest fare returned.
  • Enhanced Multi-Ticket – the new parameter allows to specify the requested number of One-Way solutions in Multi-Ticket processing.
  • Ancillary elements GAO - new Fare type descriptors in Bargain Finder Max. Exposure of new elements in the response to describe the fare type, the fare rule and fare tariff. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response.

Business Value

  • Each of these enhancements enable greater personalization and efficiency to further refine the search.

New Features

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares> <FareParameters> <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/> <FareBasis Code="ZPLAXJFK" PreferLevel="Preferred"/> <FareBasis Code="IP7J3" PreferLevel="Unacceptable"/> </FareParameters> </FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.
Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<OriginDestinationInformation RPH="1"> <DepartureDateTime>2020-01-01T00:00:00</DepartureDateTime> <OriginLocation LocationCode="LAX"/> <DestinationLocation LocationCode="JFK"/> <TPA_Extensions> <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/> <FareBasis Code=“^ZP-" PreferLevel="Unacceptable"/> <FareBasis Code="IP7J1" PreferLevel="Preferred"/> </TPA_Extensions> </OriginDestinationInformation>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.
Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares> <FareParameters> <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/> <FareBasis Code="ZPLAXJFK" PreferLevel="Preferred"/> <FareBasis Code="IP7J3" PreferLevel="Unacceptable"/> </FareParameters> </FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.
Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares> <FareParameters> <Leg Num="1"> <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/> <FareBasis Code="IP7J4" PreferLevel="Unacceptable"/> </Leg> <Leg Num="2"> <FareBasis Code="IP7J5" PreferLevel="Unacceptable"/> </Leg> </FareParameters> </FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.
Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<TravelPreferences> <TPA_Extensions> <ClassOfService Code="J" PreferLevel="Unacceptable"/> </TPA_Extensions> </TravelPreferences>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main Fare. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.
Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<OriginDestinationInformation RPH="1"> <DepartureDateTime>2019-10-27T00:00:00</DepartureDateTime> <OriginLocation LocationCode="LAX"/> <DestinationLocation LocationCode="JFK"/> <TPA_Extensions> <ClassOfService Code="J" PreferLevel="Unacceptable"/> </TPA_Extensions> </OriginDestinationInformation>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.
Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares> <FareParameters> <ClassOfService Code="O" PreferLevel="Preferred"/> <ClassOfService Code="J" PreferLevel="Unacceptable"/> </FareParameters> </FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.
Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares> <FareParameters> <Leg Num="1"> <ClassOfService Code="J" PreferLevel="Unacceptable"/> </Leg> </FareParameters> </FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.
Parameter: ParityModeForLowest

Type: string

Description: Parity mode for lowest branded fare. This parameter gives the ability to apply parity mode for the main/primary fare.

Sample Value:

<PriceRequestInformation> <TPA_Extensions> <BrandedFareIndicators SingleBrandedFare="false" ParityModeForLowest="Leg" MultipleBrandedFares="true"/> </TPA_Extensions> </PriceRequestInformation>
Note: If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. It's designed to work with MultipleBrandedFares feature only.
Parameter: RequestedOneWays

Type: positiveInteger

Description: The new parameter RequestedOneWays allows to specify the requested number of One-Way solutions in Multi-Ticket processing.

Sample Value:

<TPA_Extensions> <MultiTicket DisplayPolicy="SOW" RequestedOneWays="30"/> </TPA_Extensions>
Note: Allow to set requested number of OneWays in MultiTicket processing.
Parameter: FareComponentFareType

Type: string

Description: New Fare type descriptors in BargainFinderMax. Provides exposure of new elements in the response to describe the fare type, the fare rule, fare tariff and fare bitmap. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response. Fare type (e.g. FIT, RU).

Sample Value:

<FareBasisCodes> <FareBasisCode PrivateFareType="@" BookingCode="B" AvailabilityBreak="true" DepartureAirportCode="LAX" ArrivalAirportCode="JFK" FareComponentBeginAirport="LAX" FareComponentEndAirport="JFK" FareComponentDirectionality="FROM" FareComponentVendorCode="ATP" FareComponentFareTypeBitmap="0A" FareComponentFareType="EOU" FareComponentFareTariff="770" FareComponentFareRule="XX26" GovCarrier="AA">OVAJZNB3/DRB </FareBasisCode> </FareBasisCodes>
Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).
Parameter: FareComponentFareTariff

Type: string

Description: New Fare type descriptors in BargainFinderMax. Provides exposure of new elements in the response to describe the fare type, the fare rule, fare tariff and fare bitmap. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response. Fare tariff (e.g. 21).

Sample Value:

<FareBasisCodes> <FareBasisCode PrivateFareType="@" BookingCode="B" AvailabilityBreak="true" DepartureAirportCode="LAX" ArrivalAirportCode="JFK" FareComponentBeginAirport="LAX" FareComponentEndAirport="JFK" FareComponentDirectionality="FROM" FareComponentVendorCode="ATP" FareComponentFareTypeBitmap="0A" FareComponentFareType="EOU" FareComponentFareTariff="770" FareComponentFareRule="XX26" GovCarrier="AA">OVAJZNB3/DRB </FareBasisCode> </FareBasisCodes>
Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).
Parameter: FareComponentFareRule

Type: string

Description: New Fare type descriptors in BargainFinderMax. Provides exposure of new elements in the response to describe the fare type, the fare rule, fare tariff and fare bitmap. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response. FareRule, part of the fare pricing (e.g. 62DD, K0ST), expected if carrier uses them also in ancillaries’ records.

Sample Value:

<FareBasisCodes> <FareBasisCode PrivateFareType="@" BookingCode="B" AvailabilityBreak="true" DepartureAirportCode="LAX" ArrivalAirportCode="JFK" FareComponentBeginAirport="LAX" FareComponentEndAirport="JFK" FareComponentDirectionality="FROM" FareComponentVendorCode="ATP" FareComponentFareTypeBitmap="0A" FareComponentFareType="EOU" FareComponentFareTariff="770" FareComponentFareRule="XX26" GovCarrier="AA">OVAJZNB3/DRB </FareBasisCode> </FareBasisCodes>
Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).