API Information

Response Format
XML
Service Action Code
TravelItineraryReadRQ
Current Version
3.10.0
Target Audience
Both TN and AS
Environment
Production
Documentation
Go to the Get Itinerary documentation

What's New

  • Implementation of full TravelItineraryReadRQ flow with RBD
  • Extend insurance product for annual multi trip
  • Retrieve the owning agency PCC along with profile index from TravelItineraryRead
  • Support for PriceCache OpenReservationElement

New Features

In the Response

Required

Parameter: programID

Type: string

Description:

Sample Value:

Parameter: membershipId

Type: string

Description:

Sample Value:

Parameter: locationCode

Type: string

Description:

Sample Value:

Parameter: code

Type: string

Description:

Sample Value:

Parameter: equipType

Type: string

Description:

Sample Value:

Parameter: code

Type: string

Description:

Sample Value:

Parameter: code

Type: CarrierCode

Description: Validating Carrier code

Sample Value:

Parameter: level

Type: ValidatingCarrierPreferLevelType

Description:

Sample Value:

Parameter: RetailerRule

Type: complexType

Description:

Sample Value:

Parameter: code

Type: string

Description: pattern value=[0-9a-zA-Z]{2,20}

Sample Value:

Parameter: airlineCode

Type: CarrierCode

Description: Airline Carrier Code - override the GOVERNING CARRIER to get the fare filed by that carrier.

Sample Value:

Parameter: value

Type: integer

Description:

Sample Value:

Parameter: carrier

Type: string

Description:

Sample Value:

Parameter: tier

Type: integer

Description:

Sample Value:

Parameter: ind

Type: boolean

Description:

Sample Value:

Parameter: priority

Type: int

Description:

Sample Value:

Parameter: Carrier

Type: complexType

Description: Specifies desired order of carriers

Sample Value:

Parameter: type

Type: PassengerStatusEnumType

Description:

Sample Value:

Parameter: value

Type: string

Description: Adjustment Value, can be positive or negative, number or percentage

Sample Value:

Parameter: passengerTypeCode

Type: AlphaLength3

Description: A three-letter code representing passenger type (e.g. .ADT. for adult, .CNN. for child)

Sample Value:

Parameter: years

Type: short

Description:

Sample Value:

Parameter: currencyCode

Type: CurrencyCodeType

Description:

Sample Value:

Parameter: taxCode

Type: string

Description: Identifies the code for the tax.

Sample Value:

Optional

Parameter: Cabin

Type: CabinType

Description: Generic cabin description data

Sample Value:

Parameter: MealCode

Type: string

Description: Meal code associated with the particular flight segment

Sample Value:

Parameter: SmokingAllowed

Type: boolean

Description: Indicates whether or not smoking is permitted on the particular flight segment

Sample Value:

Parameter: StopQuantity

Type: int

Description: Number of stops associated with the particular flight segment

Sample Value:

Parameter: ElapsedTime

Type: int

Description: The elapsed time in minutes associated with the particular flight segment

Sample Value:

Parameter: AirMilesFlown

Type: int

Description: Air miles flown associated with the particular flight segment

Sample Value:

Parameter: HiddenStop

Type: complexType

Description: Used to return hidden stop details

Sample Value:

Parameter: ArrivalDateTime

Type: string

Description: Arrival date and time to hidden stop

Sample Value:

Parameter: DepartureDateTime

Type: string

Description: Departure date and time from hidden stop

Sample Value:

Parameter: Airport

Type: string

Description: "Airport" is used to determine airport location code

Sample Value:

Parameter: FunnelFlight

Type: boolean

Description: "FunnelFlight" is used to determine a funnel flight type for flight segment

Sample Value:

Parameter: ChangeOfGauge

Type: boolean

Description: "ChangeOfGauge" is used to determine a change of gauge for flight segment

Sample Value:

Parameter: DisclosureCarrier

Type: complexType

Description: Disclosure Carrier is used to return operated flight data

Sample Value:

Parameter: Banner

Type: string

Description: "DisclosureCarrier/Banner" is used to return the disclosure carrier name

Sample Value:

Parameter: Code

Type: string

Description: "Code" is used to return the disclosure carrier code associated with the particular vehicle segment

Sample Value:

Parameter: DOT

Type: boolean

Description: "DOT" is optional data from DSS (DOT) it determines Banner appearance

Sample Value:

Parameter: FareComponent

Type: FareComponentWithId

Description: Fare Component information

Sample Value:

Parameter: CabinType

Type: complexType

Description: Cabin data form ATPCO RBD Answer Table (A02 record)

Sample Value:

Parameter: code

Type: string

Description: Reservation Booking Designator code

Sample Value:

Parameter: sabreCode

Type: string

Description: Reservation Booking Designator Sabre code

Sample Value:

Parameter: name

Type: string

Description: Long name of the Reservation booking designator. Example: Premium Economy

Sample Value:

Parameter: shortName

Type: string

Description: Short name of the Reservation booking designator. Example: PR ECON.

Sample Value:

Parameter: lang

Type: string

Description: Language of the names

Sample Value:

Parameter: BaggageInformationType

Type: complexType

Description: Information about baggage

Sample Value:

Parameter: Allowance

Type: complexType

Description:

Sample Value:

Parameter: passengerType

Type: string

Description: Type of Passenger

Sample Value:

Parameter: pieces

Type: int

Description: Number of Pieces

Sample Value:

Parameter: weight

Type: int

Description: Weight Limit

Sample Value:

Parameter: unit

Type: string

Description: Units of the Weight Limit

Sample Value:

Parameter: InsuranceOptOut

Type: InsuranceOptOut

Description:

Sample Value:

Parameter: Profile

Type: ProfileType

Description:

Sample Value:

Parameter: PriceSummary

Type: PriceSummaryType

Description:

Sample Value:

Parameter: PriceProvider

Type: PricingProviderType

Description:

Sample Value:

Parameter: PriceSummaryType

Type: complexType

Description:

Sample Value:

Parameter: BasePrice

Type: DecimalPrice

Description:

Sample Value:

Parameter: EquivPrice

Type: DecimalPrice

Description:

Sample Value:

Parameter: TotalTaxes

Type: TaxesType

Description:

Sample Value:

Parameter: TotalPrice

Type: DecimalPrice

Description:

Sample Value:

Parameter: id

Type: int

Description:

Sample Value:

Parameter: refreshTimestamp

Type: dateTime

Description:

Sample Value:

Parameter: TaxesType

Type: complexType

Description:

Sample Value:

Parameter: Tax

Type: TaxType

Description:

Sample Value:

Parameter: TaxType

Type: complexType

Description:

Sample Value:

Parameter: TaxAmount

Type: DecimalPrice

Description:

Sample Value:

Parameter: TaxCode

Type: CommonString

Description:

Sample Value:

Parameter: ProductSource

Type: ProductSourceType

Description:

Sample Value:

Parameter: ProductSourceType

Type: complexType

Description:

Sample Value:

Parameter: code

Type: string

Description:

Sample Value:

Parameter: name

Type: string

Description:

Sample Value:

Parameter: vendorName

Type: string

Description:

Sample Value:

Parameter: supplierName

Type: string

Description:

Sample Value:

Parameter: supplierCode

Type: string

Description:

Sample Value:

Parameter: FareComponentWithId

Type: complexType

Description:

Sample Value:

Parameter: FareComponent

Type: int

Description:

Sample Value:

Parameter: FareComponentID

Type: int

Description: Numeric value identifying fare component

Sample Value:

Parameter: ProfileType

Type: complexType

Description:

Sample Value:

Parameter: ID

Type: string

Description:

Sample Value:

Parameter: Type

Type: string

Description: Type of Profile, it will be having full name like TAGENCY, TAGENCT etc

Sample Value:

Parameter: Source

Type: string

Description:

Sample Value:

Parameter: ShortType

Type: string

Description: Type of Profile, same as above but in short, it will be having name like AGY, AGT

Sample Value:

Parameter: PolicyId

Type: string

Description: PolicyId of the profile

Sample Value:

Parameter: PreferenceId

Type: string

Description: PreferenceId of the profile

Sample Value:

Parameter: PolicyRemovalReason

Type: string

Description: Reason for removing the reason

Sample Value:

Parameter: OwningAgency

Type: string

Description: Name of the PCC where this profile is stored

Sample Value:

Parameter: TierPriority

Type: short

Description:

Sample Value:

Parameter: Acquirer

Type: string

Description: SabrePWS if Sabre Payment Web Services. User may enter any value for 3rd party acquirer.

Sample Value:

Parameter: MaxDurationDays

Type: string

Description: Max duration associated with annual multi trip product.

Sample Value:

Parameter: PricingProviderType

Type: complexType

Description:

Sample Value:

Parameter: ProviderName

Type: string

Description:

Sample Value:

Parameter: PricingOptions

Type: PricingRequestInformationType

Description:

Sample Value:

Parameter: PricingRequestInformationType

Type: complexType

Description:

Sample Value:

Parameter: AirPriceQualifiers

Type: AirPriceQualifiersType

Description:

Sample Value:

Parameter: HotelRateQualifiers

Type: HotelRateQualifiersType

Description:

Sample Value:

Parameter: CarRateQualifiers

Type: CarRateQualifiersType

Description:

Sample Value:

Parameter: PromotionEnumtype

Type: string

Description:

Sample Value:

Parameter: AirPriceQualifiersType

Type: complexType

Description: Specifies passenger numbers and types.

Sample Value:

Parameter: SeatsRequested

Type: nonNegativeInteger

Description: The sum of all seats required by all passenger groups.

Sample Value:

Parameter: AirTravelerAvail

Type: TravelerInformationType

Description: Specifies passenger numbers and types.

Sample Value:

Parameter: PriceRequestOptions

Type: PriceRequestOptionsType

Description: Identify pricing source, if negotiated fares are requested and if it is a reprice request.

Sample Value:

Parameter: TravelerRating

Type: TravelerRatingType

Description: Customer Value Scores and Frequent Flyer Tiers for one traveler. It can influence Availability results when provided.

Sample Value:

Parameter: GoverningCarrierOverride

Type: GoverningCarrierOverrideType

Description: Airline Carrier Code - override the GOVERNING CARRIER to get the fare filed by that carrier.

Sample Value:

Parameter: VoluntaryChanges

Type: VoluntaryChangesSMPType

Description: Identifies whether penalties associated with voluntary changes should be included in the search results.

Sample Value:

Parameter: RetailerRules

Type: RetailerRulesType

Description:

Sample Value:

Parameter: TaxRules

Type: TaxRulesType

Description: Contains tax depending rules.

Sample Value:

Parameter: ValidatingCarrier

Type: ValidatingCarrierType

Description: Validating carrier rule.

Sample Value:

Parameter: CabinPref

Type: CabinPrefType

Description: Defines preferred cabin to be used in a search for this leg level (if SegmentType is "O") or segment (if SegmentType is "X"). The cabin type specified in this element will override the cabin type specified at the request level for this leg/segment. If a cabin type is not specified for this element the cabin type at request level will be used as default for this leg or segment. If the cabin type is not specified at both the leg/segment level and request level a default cabin of "Economy" will be used

Sample Value:

Parameter: specificPTC_Indicator

Type: boolean

Description: If true, this request is for a specific PTC and only fares applicable to that PTC will be checked and returned. It is the same as XOFares flag in Intellisell request.

Sample Value:

Parameter: tripType

Type: AirTripType

Description: Specify air trip type.

Sample Value:

Parameter: xOFares

Type: boolean

Description: XOFares indicator

Sample Value:

Parameter: CarRateQualifiersType

Type: complexType

Description:

Sample Value:

Parameter: Corporate

Type: complexType

Description:

Sample Value:

Parameter: ID

Type: string

Description:

Sample Value:

Parameter: CustLoyalty

Type: complexType

Description:

Sample Value:

Parameter: GuaranteePrepaid

Type: complexType

Description:

Sample Value:

Parameter: returnGuaranteedRates

Type: boolean

Description:

Sample Value:

Parameter: returnPrepaidRates

Type: boolean

Description:

Sample Value:

Parameter: returnRegularRates

Type: boolean

Description:

Sample Value:

Parameter: ID

Type: complexType

Description:

Sample Value:

Parameter: Number

Type: string

Description:

Sample Value:

Parameter: Promotion

Type: complexType

Description:

Sample Value:

Parameter: Code

Type: string

Description:

Sample Value:

Parameter: type

Type: PromotionEnumtype

Description:

Sample Value:

Parameter: RateCode

Type: string

Description:

Sample Value:

Parameter: TourCode

Type: complexType

Description:

Sample Value:

Parameter: Text

Type: string

Description:

Sample Value:

Parameter: VehiclePreferences

Type: complexType

Description:

Sample Value:

Parameter: Preference

Type: complexType

Description:

Sample Value:

Parameter: VehicleType

Type: string

Description:

Sample Value:

Parameter: LocationPreferences

Type: complexType

Description:

Sample Value:

Parameter: cityLocation

Type: string

Description:

Sample Value:

Note: Possible values are: "E:, "N", "S", "W", "C", "R", "A", "I", "P", "X", "H"
Parameter: VendorPreferences

Type: complexType

Description:

Sample Value:

Parameter: VendorPreference

Type: complexType

Description:

Sample Value:

Parameter: exclude

Type: boolean

Description:

Sample Value:

Parameter: SpecialEquipmentPreferences

Type: complexType

Description:

Sample Value:

Parameter: Preference

Type: complexType

Description:

Sample Value:

Parameter: ccRate

Type: string

Description:

Sample Value:

Parameter: commission

Type: boolean

Description:

Sample Value:

Parameter: currencyCode

Type: string

Description:

Sample Value:

Parameter: mileagePlan

Type: string

Description:

Sample Value:

Parameter: rateAssured

Type: boolean

Description:

Sample Value:

Parameter: rateCategory

Type: string

Description:

Sample Value:

Parameter: ratePlan

Type: string

Description:

Sample Value:

Parameter: HotelRateQualifiersType

Type: complexType

Description:

Sample Value:

Parameter: RateAccessCode

Type: complexType

Description:

Sample Value:

Parameter: ContractNegotiatedRateCode

Type: string

Description:

Sample Value:

Parameter: RatePlanCode

Type: complexType

Description:

Sample Value:

Parameter: ValidatingCarrierType

Type: complexType

Description:

Sample Value:

Parameter: Preference

Type: complexType

Description:

Sample Value:

Parameter: TaxRulesType

Type: complexType

Description: Combines exemption rules connected with taxes.

Sample Value:

Parameter: ExemptAllTaxes

Type: boolean

Description: Exempt all taxes (/TE)

Sample Value:

Parameter: ExemptTax

Type: TaxCodeType

Description: Exempt Tax (/TE)

Sample Value:

Parameter: RetailerRulesType

Type: complexType

Description:

Sample Value:

Parameter: force

Type: boolean

Description: If set to true, only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned

Sample Value:

Parameter: VoluntaryChangesSMPType

Type: complexType

Description: Specifies charges and/or penalties associated with making ticket changes after purchase.

Sample Value:

Parameter: Penalty

Type: complexType

Description: Specifies penalty charges as either a currency amount or a percentage of the fare.

Sample Value:

Parameter: type

Type: string

Description: Indicates the type (Refund or Exchange) of penalty involved in the search or response.

Sample Value:

Note: Possible values are: "Refund" and "Exchange"
Parameter: exclude

Type: boolean

Description: Indicate that specific penalty type should be excluded from the response.

Sample Value:

Parameter: application

Type: string

Description: Identifier used to indicate whether the change occurs before or after departure from the origin city.

Sample Value:

Note: Possible values are: "After" and "Before"
Parameter: match

Type: string

Description: Indicates relation between conditions.

Sample Value:

Note: Possible values are: "All" - Conditions are joined by logical conjunction - fare needs to fulfill all the conditions to be returned in response.; "Any" - Conditions are joined by logical disjunction - fare needs to fulfill at least one of the conditions to be returned in response.; "Info" - Return penalty information
Parameter: GoverningCarrierOverrideType

Type: complexType

Description:

Sample Value:

Parameter: TravelerRatingType

Type: complexType

Description: Customer Value Scores and Frequent Flyer Tiers for one traveler. It can influence Availability results when provided.

Sample Value:

Parameter: Score

Type: ScoreType

Description:

Sample Value:

Parameter: FrequentFlyer

Type: FrequentFlyerType

Description:

Sample Value:

Parameter: ScoreType

Type: complexType

Description:

Sample Value:

Parameter: FrequentFlyerType

Type: complexType

Description:

Sample Value:

Parameter: NegotiatedFareCodeType

Type: complexType

Description:

Sample Value:

Parameter: Supplier

Type: string

Description: This element indicates the supplier associated with a negotiated fare code.

Sample Value:

Parameter: AccountCodeType

Type: complexType

Description:

Sample Value:

Parameter: IndDefaultFalseType

Type: complexType

Description:

Sample Value:

Parameter: ind

Type: boolean

Description:

Sample Value:

Parameter: IndType

Type: complexType

Description:

Sample Value:

Parameter: IndRequiredType

Type: complexType

Description:

Sample Value:

Parameter: PriorityType

Type: complexType

Description:

Sample Value:

Parameter: PriorityLegType

Type: complexType

Description:

Sample Value:

Parameter: leg

Type: positiveInteger

Description:

Sample Value:

Parameter: CarrierType

Type: complexType

Description:

Sample Value:

Parameter: PriorityComplexType

Type: complexType

Description:

Sample Value:

Parameter: Price

Type: PriorityType

Description: Prefer cheaper itineraries

Sample Value:

Parameter: DirectFlights

Type: PriorityLegType

Description: Prefer itineraries will less connections

Sample Value:

Parameter: Time

Type: PriorityType

Description: Prefer itineraries departing closer to requested departure time

Sample Value:

Parameter: Vendor

Type: PriorityType

Description: Promote certain marketing carriers over all the others in returning results. (configured in rules).

Sample Value:

Parameter: MarketingCarrier

Type: CarrierType

Description: Prefer itineraries with marketing carriers in order speciied in Carrier subtags, comparing segment-wise

Sample Value:

Parameter: OperatingCarrier

Type: CarrierType

Description: Prefer itineraries with operating carriers in order speciied in Carrier subtags, comparing segment-wise

Sample Value:

Parameter: ElapsedTime

Type: PriorityType

Description: Prefer itineraries with shorter travel times

Sample Value:

Parameter: DepartureTime

Type: PriorityLegType

Description: Prefer itineraries departing earlier during the day

Sample Value:

Parameter: ConnectionTime

Type: PriorityLegType

Description: Prefer itineraries with smaller amount of time waiting in the airports during connections

Sample Value:

Parameter: IndicatorsType

Type: complexType

Description:

Sample Value:

Parameter: RetainFare

Type: IndRequiredType

Description: If set to true, fares that have a min/max stay can be included in the responses. If set to false, then no fares that include a min/max stay requirement will be included in the response.

Sample Value:

Parameter: RefundPenalty

Type: IndRequiredType

Description: If set to true, fares that have a refund penalty can be included in the responses. If set to false, then no fares that include a refund penalty requirement will be included in the response.

Sample Value:

Parameter: ResTicketing

Type: IndRequiredType

Description: If set to true, fares that have a reservation/ticketing can be included in the responses. If set to false, then no fares that include reservation/ticketing requirement will be included in the response.

Sample Value:

Parameter: TravelPolicy

Type: IndRequiredType

Description: This element is currently ignored whether it is true or false.

Sample Value:

Parameter: CustomerComplexType

Type: string

Description:

Sample Value:

Note: Possible values are: "REGULAR" - Regular customer type.; "TVLYPREF" - TVLY_PREFERRED customer type.; "PREFELITE" - PREFERED_ELITE customer type.; "LOYALTY" - LOYALTY customer type.
Parameter: ItinerariesPerGroupType

Type: complexType

Description:

Sample Value:

Parameter: itinerariesPerGroup

Type: int

Description: Indicates desired number of itineraries to be returned in each passenger group at begining of response.

Sample Value:

Parameter: BrandedFareIndicatorsType

Type: complexType

Description:

Sample Value:

Parameter: ReturnCheapestUnbrandedFare

Type: IndRequiredType

Description:

Sample Value:

Parameter: singleBrandedFare

Type: boolean

Description: Return single brand option per itin

Sample Value:

Parameter: multipleBrandedFares

Type: boolean

Description: Return multiple brand options per itin

Sample Value:

Parameter: returnBrandAncillaries

Type: boolean

Description: Return ancillaries from the ATPCO Branded Fares Feature

Sample Value:

Parameter: PassengerStatusEnumType

Type: string

Description: Possible values are: "R" - Residency; "E" - Employment; "N" Nationality

Sample Value:

Parameter: PassengerStatusType

Type: complexType

Description:

Sample Value:

Parameter: StateCode

Type: string

Description:

Sample Value:

Parameter: CountryCode

Type: string

Description:

Sample Value:

Parameter: CityCode

Type: AlphaLength3

Description:

Sample Value:

Parameter: ETicketableOverrideType

Type: complexType

Description:

Sample Value:

Parameter: CurrencyType

Type: complexType

Description:

Sample Value:

Parameter: dual

Type: AlphaLength3

Description: Dual currency

Sample Value:

Parameter: mOverride

Type: boolean

Description: M override

Sample Value:

Parameter: OBFeesType

Type: complexType

Description:

Sample Value:

Parameter: rType

Type: boolean

Description: Indicator Returning R-Type OB Fees

Sample Value:

Parameter: tType

Type: boolean

Description: Indicator Returning T-Type OB Fees

Sample Value:

Parameter: FareAdjustmentType

Type: complexType

Description:

Sample Value:

Parameter: currency

Type: AlphaLength3

Description: Currency of Adjustment's Value

Sample Value:

Parameter: ValueType

Type: complexType

Description:

Sample Value:

Parameter: value

Type: decimal

Description:

Sample Value:

Parameter: PriceRequestOptionsType

Type: complexType

Description: Identify pricing source, if negotiated fares are requested and if it is a reprice request.

Sample Value:

Parameter: NegotiatedFareCode

Type: NegotiatedFareCodeType

Description:

Sample Value:

Parameter: AccountCode

Type: AccountCodeType

Description:

Sample Value:

Parameter: PublicFare

Type: IndDefaultFalseType

Description: This element finds only public fares.

Sample Value:

Parameter: PrivateFare

Type: IndDefaultFalseType

Description: This element finds only private fares.

Sample Value:

Parameter: IATAFare

Type: IndDefaultFalseType

Description: This element finds only IATA fares.

Sample Value:

Parameter: WebFare

Type: IndType

Description: Web fare

Sample Value:

Parameter: Priority

Type: PriorityComplexType

Description: This element governs how flights are returned. A user can uses a priority of 1-9 to make this determination.

Sample Value:

Parameter: Indicators

Type: IndicatorsType

Description: This element restricts fares which can be returned in response. If a customer passes this element, all its children should be specified.

Sample Value:

Parameter: PromoID

Type: string

Description: Promotional Identifier - a string which identifies a promotion, possibly giving a discount prices etc.

Sample Value:

Parameter: CustomerType

Type: CustomerComplexType

Description:

Sample Value:

Parameter: MultipleTravelerGroups

Type: ItinerariesPerGroupType

Description: This element governs how flights are returned when multiple passenger groups are requested.

Sample Value:

Parameter: BrandedFareIndicators

Type: BrandedFareIndicatorsType

Description:

Sample Value:

Parameter: PassengerStatus

Type: PassengerStatusType

Description:

Sample Value:

Parameter: PointOfSaleOverride

Type: string

Description: Will return the fares available for specified point of sale and priced in this point of sale currency. Currency is overridden b PriceRequestInformation@CurrencyCode.

Sample Value:

Parameter: PointOfTicketingOverride

Type: string

Description:

Sample Value:

Parameter: ApplyResidentDiscount

Type: boolean

Description: Apply resident discount in CLFE

Sample Value:

Parameter: ETicketableOverride

Type: ETicketableOverrideType

Description:

Sample Value:

Parameter: Currency

Type: CurrencyType

Description:

Sample Value:

Parameter: UseReducedConstructions

Type: IndType

Description: Use reduced constructions (simple fare paths with restrictions on the number of fare components).

Sample Value:

Parameter: OBFees

Type: OBFeesType

Description:

Sample Value:

Parameter: FareBreaksAtLegs

Type: IndType

Description: Force fare breaks at leg points if split taxes by leg requested. By default set to true.

Sample Value:

Parameter: FareAdjustment

Type: FareAdjustmentType

Description: Capability to specify Plus-Up and Discount Amount and Percentage.

Sample Value:

Parameter: ForceCompanion

Type: ValueType

Description: Force companion fare value.

Sample Value:

Parameter: UsePassengerFares

Type: IndRequiredType

Description: At least one fare component for each passenger type must be applicable for that passenger type.

Sample Value:

Parameter: UseNegotiatedFares

Type: IndRequiredType

Description: At least one fare component for each passenger type must be applicable for that passenger type.

Sample Value:

Parameter: UseNegotiatedFares

Type: IndRequiredType

Description: Returned fares need to match AcccountCode/CorporateID on at least one fare component.

Sample Value:

Parameter: negotiatedFaresOnly

Type: boolean

Description: If set to true then returned fares need to match requested AcccountCode/CorpID on all fare components

Sample Value:

Parameter: currencyCode

Type: AlphaLength3

Description: Type of funds preferred for reviewing monetary values, in ISO 4217 codes.

Sample Value:

Parameter: pricingSource

Type: RequestPricingSourceType

Description: It can be used to indicate whether the fare is public or private.

Sample Value:

Parameter: reprice

Type: boolean

Description:

Sample Value:

Parameter: processThruFaresOnly

Type: boolean

Description: Activates processing of thru fares only.

Sample Value:

Parameter: purchaseDate

Type: date

Description: Specify purchase date. Fares returned will be based on the purchase date.

Sample Value:

Parameter: purchaseTime

Type: string

Description: Specify purchase time. Fares returned will be based on the purchase time.

Sample Value:

Parameter: netFaresUsed

Type: boolean

Description: Set to true when exchange ticket uses net fare.

Sample Value:

Parameter: RequestPricingSourceType

Type: string

Description: It can be used to indicate whether the fare is public or private.

Sample Value:

Note: Possible values are: "Published", "Private", "Both"
Parameter: secondaryCode

Type: string

Description: An additional attribute to allow flexibility for particular organizations who require an additional code.

Sample Value:

Parameter: supplierCode

Type: string

Description: An additional attribute to allow flexibility for particular organizations who require an additional supplier code.

Sample Value:

Parameter: codeContext

Type: string

Description: Identifies the source authority for the code.

Sample Value:

Parameter: URI

Type: anyURI

Description: Identifies the location of the code table

Sample Value:

Parameter: quantity

Type: int

Description: Specifies the number of items that are identified by the Code (e.g., 2 adults, 5 first class seats).

Sample Value:

Parameter: TravelerInformationType

Type: complexType

Description: Specifies passenger numbers and types.

Sample Value:

Parameter: PassengerTypeQuantity

Type: PassengerTypeQuantityType

Description: Specifies number of passengers using Passenger Type Codes.

Sample Value:

Parameter: AirTraveler

Type: AirTravelerType

Description: Information profiling the person traveling Gender - the gender of the customer, if needed BirthDate - Date of Birth Currency - the preferred currency in which monetary amounts should be returned.

Sample Value:

Parameter: AirTravelerType

Type: complexType

Description: Information about the person traveling. Gender - the gender of the customer, if needed. BirthDate - Date of Birth. Currency - the preferred currency in which monetary amounts should be returned.

Sample Value:

Parameter: CustLoyalty

Type: CustLoyaltyType

Description: Specify a customer loyalty program.

Sample Value:

Parameter: PassengerTypeQuantity

Type: PassengerTypeQuantityType

Description: Define information on the number of passengers of a specific type.

Sample Value:

Parameter: TravelerRefNumber

Type: TravelerRefNumberType

Description: Direct reference of traveler assigned by requesting system. Used as a cross reference between data segments.

Sample Value:

Parameter: FlightSegmentRPHs

Type: FlightSegmentRPHsType

Description: Reference pointers to flight segments

Sample Value:

Parameter: currencyCode

Type: AlphaLength3

Description: The preferred currency in which monetary amounts should be returned.

Sample Value:

Parameter: accompaniedByInfant

Type: boolean

Description: Indicates if an infant accompanying a traveler is with or without a seat.

Sample Value:

Parameter: FlightSegmentRPHsType

Type: complexType

Description:

Sample Value:

Parameter: FlightSegmentRPH

Type: string

Description: Reference to the flight segments for this traveler

Sample Value:

Parameter: TravelerRefNumberType

Type: complexType

Description: A reference place holder used as a pointer to link back to the traveler.

Sample Value:

Parameter: RPH

Type: string

Description: Reference place holder.

Sample Value:

Parameter: CustLoyaltyType

Type: complexType

Description: Program rewarding frequent use by accumulating credits for services provided by vendors.

Sample Value:

Parameter: programID

Type: string

Description: Identifier to indicate the company owner of the loyalty program.

Sample Value:

Parameter: membershipID

Type: string

Description: Unique identifier of the member in the program (membership number, account number, etc.).

Sample Value:

Parameter: travelSector

Type: string

Description: Identifies the travel sector. Refer to OTA Code List Travel Sector (TVS).

Sample Value:

Parameter: loyalLevel

Type: string

Description:

Sample Value:

Parameter: singleVendorInd

Type: SingleVendorIndType

Description:

Sample Value:

Parameter: signupDate

Type: date

Description:

Sample Value:

Parameter: RPH

Type: string

Description: Reference place holder, to reference it back in the response.

Sample Value:

Parameter: SingleVendorIndType

Type: simpleType

Description: Indicates if program is affiliated with a group of related offers accumulating credits.

Sample Value:

Note: Possible values are: "SingleVndr" and "Alliance"
Parameter: PassengerTypeQuantityType

Type: complexType

Description: Specifies a PTC (Passenger Type Code) and the associated number of PTC's - for use in specifying passenger lists.

Sample Value:

Parameter: BirthDate

Type: BirthDateType

Description:

Sample Value:

Parameter: Age

Type: AgeType

Description: Exchange-specific

Sample Value:

Parameter: State

Type: StateType

Description: Exchange-specific

Sample Value:

Parameter: TotalNumber

Type: TotalNumberType

Description: Exchange-specific

Sample Value:

Parameter: changeable

Type: boolean

Description:

Sample Value:

Parameter: index

Type: int

Description: Allows to identify which one of requested passengers this solution relates to.

Sample Value:

Parameter:

Type:

Description:

Sample Value:

Parameter: requestedPassengerIndex

Type: nonNegativeInteger

Description: Allows to identify which one of requested passenger groups from Exchange request this solution relates to.

Sample Value:

Parameter: BirthDateType

Type: complexType

Description:

Sample Value:

Parameter: date

Type: date

Description:

Sample Value:

Parameter: AgeType

Type: complexType

Description:

Sample Value:

Parameter: StateType

Type: complexType

Description:

Sample Value:

Parameter: TotalNumberType

Type: complexType

Description:

Sample Value:

Parameter: AlphaLength3

Type: string

Description: Used for Alphabetic Strings, length exactly 3

Sample Value:

Note: pattern value="[a-zA-Z]{3}"
Parameter: TravelerCountType

Type: complexType

Description: Defines the number of travelers of a specific type (e.g. a driver type can be either one of: Adult, YoungDriver, YoungerDriver, or it may be a code that is acceptable to both Trading Partners).

Sample Value:

Parameter: URI

Type: anyURI

Description: Identifies the location of the code table

Sample Value:

Parameter: quantity

Type: int

Description: Specifies the number of travelers.

Sample Value:

Parameter: DecimalPrice

Type: complexType

Description: Provides a monetary amount and the currency code to reflect the currency in which this amount is expressed.

Sample Value:

Parameter: TaxCodeType

Type: complexType

Description: Defines the data fields available for tax code.

Sample Value:

Parameter: CabinPrefType

Type: complexType

Description: Indicates preferences for choice of airline cabin for a given travel situation.

Sample Value:

Parameter: preferLevel

Type: PreferLevelType

Description: Used to indicate a level of preference for an associate item, only, unacceptable, preferred.

Sample Value:

Parameter: cabin

Type: CabinNameType

Description: Specify cabin type

Sample Value:

Parameter: CabinNameType

Type: NMTOKEN

Description: cabin is either Premium First (P), First (F), Premium Business (J), Business (C), Premium Economy (S) or Economy (Y)

Sample Value:

Note: Possible values are: "PremiumFirst", "First", "PremiumBusiness", "Business", "PremiumEconomy", "Economy", "Y", "S", "C", "J", "F", "P"
Parameter: PreferLevelType

Type: NMTOKEN

Description: Used to specify a preference level for something that is or will be requested (e.g. a supplier of a service, a type of service, a form of payment, etc.).

Sample Value:

Note: Possible values are: "Only", "Unacceptable", "Preferred"
Parameter: Money

Type: decimal

Description: Used for amounts, max 3 decimals

Sample Value:

Parameter: currencyCode

Type: CurrencyCodeType

Description: A currency code (e.g. USD, EUR, PLN)

Sample Value:

Parameter: decimalPlaces

Type: nonNegativeInteger

Description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit".

Sample Value:

Parameter: amount

Type: Money

Description:

Sample Value:

Parameter: CurrencyCodeType

Type: simpleType

Description: Used for Currency Codes

Sample Value:

Parameter: CarrierCode

Type: string

Description:

Sample Value:

Note: pattern value="[0-9A-Z]{2,3}
Parameter: AirTripType

Type: string

Description: Identifies the trip type - one way, return, circle trip, open jaw.

Sample Value:

Note: Possible values are: "OneWay", "Return", "Circle", "OpenJaw", "Other"
Parameter: ValidatingCarrierPreferLevelType

Type: NMTOKEN

Description: Used to specify a preference level for ValidatingCarrier. For adding new enums see PreferLevelType.

Sample Value:

Note: Possible values are: "Unacceptable", "Preferred"