v3.10.0 | November 16, 2017
- 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
API Information
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
Optional
- Parameter: Cabin
-
Type: CabinType
Description: Generic cabin description data
In the Response
Optional
- Parameter: MealCode
-
Type: string
Description: Meal code associated with the particular flight segment
In the Response
Optional
- Parameter: SmokingAllowed
-
Type: boolean
Description: Indicates whether or not smoking is permitted on the particular flight segment
In the Response
Optional
- Parameter: StopQuantity
-
Type: int
Description: Number of stops associated with the particular flight segment
In the Response
Optional
- Parameter: ElapsedTime
-
Type: int
Description: The elapsed time in minutes associated with the particular flight segment
In the Response
Optional
- Parameter: AirMilesFlown
-
Type: int
Description: Air miles flown associated with the particular flight segment
In the Response
Optional
- Parameter: HiddenStop
-
Type: complexType
Description: Used to return hidden stop details
In the Response
Optional
- Parameter: ArrivalDateTime
-
Type: string
Description: Arrival date and time to hidden stop
In the Response
Optional
- Parameter: DepartureDateTime
-
Type: string
Description: Departure date and time from hidden stop
In the Response
Optional
- Parameter: Airport
-
Type: string
Description: "Airport" is used to determine airport location code
In the Response
Optional
- Parameter: FunnelFlight
-
Type: boolean
Description: "FunnelFlight" is used to determine a funnel flight type for flight segment
In the Response
Optional
- Parameter: ChangeOfGauge
-
Type: boolean
Description: "ChangeOfGauge" is used to determine a change of gauge for flight segment
In the Response
Optional
- Parameter: DisclosureCarrier
-
Type: complexType
Description: Disclosure Carrier is used to return operated flight data
In the Response
Optional
- Parameter: Banner
-
Type: string
Description: "DisclosureCarrier/Banner" is used to return the disclosure carrier name
In the Response
Optional
- Parameter: Code
-
Type: string
Description: "Code" is used to return the disclosure carrier code associated with the particular vehicle segment
In the Response
Optional
- Parameter: DOT
-
Type: boolean
Description: "DOT" is optional data from DSS (DOT) it determines Banner appearance
In the Response
Optional
- Parameter: FareComponent
-
Type: FareComponentWithId
Description: Fare Component information
In the Response
Optional
- Parameter: CabinType
-
Type: complexType
Description: Cabin data form ATPCO RBD Answer Table (A02 record)
In the Response
Optional
- Parameter: code
-
Type: string
Description: Reservation Booking Designator code
In the Response
Optional
- Parameter: sabreCode
-
Type: string
Description: Reservation Booking Designator Sabre code
In the Response
Optional
- Parameter: name
-
Type: string
Description: Long name of the Reservation booking designator. Example: Premium Economy
In the Response
Optional
- Parameter: shortName
-
Type: string
Description: Short name of the Reservation booking designator. Example: PR ECON.
In the Response
Optional
- Parameter: lang
-
Type: string
Description: Language of the names
In the Response
Optional
- Parameter: BaggageInformationType
-
Type: complexType
Description: Information about baggage
In the Response
Optional
- Parameter: Allowance
-
Type: complexType
In the Response
Optional
- Parameter: passengerType
-
Type: string
Description: Type of Passenger
In the Response
Optional
- Parameter: pieces
-
Type: int
Description: Number of Pieces
In the Response
Optional
- Parameter: weight
-
Type: int
Description: Weight Limit
In the Response
Optional
- Parameter: unit
-
Type: string
Description: Units of the Weight Limit
In the Response
Optional
- Parameter: InsuranceOptOut
-
Type: InsuranceOptOut
In the Response
Optional
- Parameter: Profile
-
Type: ProfileType
In the Response
Optional
- Parameter: PriceSummary
-
Type: PriceSummaryType
In the Response
Optional
- Parameter: PriceProvider
-
Type: PricingProviderType
In the Response
Optional
- Parameter: PriceSummaryType
-
Type: complexType
In the Response
Optional
- Parameter: BasePrice
-
Type: DecimalPrice
In the Response
Optional
- Parameter: EquivPrice
-
Type: DecimalPrice
In the Response
Optional
- Parameter: TotalTaxes
-
Type: TaxesType
In the Response
Optional
- Parameter: TotalPrice
-
Type: DecimalPrice
In the Response
Optional
- Parameter: id
-
Type: int
In the Response
Optional
- Parameter: refreshTimestamp
-
Type: dateTime
In the Response
Optional
- Parameter: TaxesType
-
Type: complexType
In the Response
Optional
- Parameter: Tax
-
Type: TaxType
In the Response
Optional
- Parameter: TaxType
-
Type: complexType
In the Response
Optional
- Parameter: TaxAmount
-
Type: DecimalPrice
In the Response
Optional
- Parameter: TaxCode
-
Type: CommonString
In the Response
Optional
- Parameter: ProductSource
-
Type: ProductSourceType
In the Response
Optional
- Parameter: ProductSourceType
-
Type: complexType
In the Response
Optional
- Parameter: code
-
Type: string
In the Response
Optional
- Parameter: name
-
Type: string
In the Response
Optional
- Parameter: vendorName
-
Type: string
In the Response
Optional
- Parameter: supplierName
-
Type: string
In the Response
Optional
- Parameter: supplierCode
-
Type: string
In the Response
Optional
- Parameter: FareComponentWithId
-
Type: complexType
In the Response
Optional
- Parameter: FareComponent
-
Type: int
In the Response
Optional
- Parameter: FareComponentID
-
Type: int
Description: Numeric value identifying fare component
In the Response
Optional
- Parameter: ProfileType
-
Type: complexType
In the Response
Optional
- Parameter: ID
-
Type: string
In the Response
Optional
- Parameter: Type
-
Type: string
Description: Type of Profile, it will be having full name like TAGENCY, TAGENCT etc
In the Response
Optional
- Parameter: Source
-
Type: string
In the Response
Optional
- Parameter: ShortType
-
Type: string
Description: Type of Profile, same as above but in short, it will be having name like AGY, AGT
In the Response
Optional
- Parameter: PolicyId
-
Type: string
Description: PolicyId of the profile
In the Response
Optional
- Parameter: PreferenceId
-
Type: string
Description: PreferenceId of the profile
In the Response
Optional
- Parameter: PolicyRemovalReason
-
Type: string
Description: Reason for removing the reason
In the Response
Optional
- Parameter: OwningAgency
-
Type: string
Description: Name of the PCC where this profile is stored
In the Response
Optional
- Parameter: TierPriority
-
Type: short
In the Response
Optional
- Parameter: Acquirer
-
Type: string
Description: SabrePWS if Sabre Payment Web Services. User may enter any value for 3rd party acquirer.
In the Response
Optional
- Parameter: MaxDurationDays
-
Type: string
Description: Max duration associated with annual multi trip product.
In the Response
Optional
- Parameter: PricingProviderType
-
Type: complexType
In the Response
Optional
- Parameter: ProviderName
-
Type: string
In the Response
Optional
- Parameter: PricingOptions
-
Type: PricingRequestInformationType
In the Response
Optional
- Parameter: PricingRequestInformationType
-
Type: complexType
In the Response
Optional
- Parameter: AirPriceQualifiers
-
Type: AirPriceQualifiersType
In the Response
Optional
- Parameter: HotelRateQualifiers
-
Type: HotelRateQualifiersType
In the Response
Optional
- Parameter: CarRateQualifiers
-
Type: CarRateQualifiersType
In the Response
Optional
- Parameter: PromotionEnumtype
-
Type: string
In the Response
Optional
- Parameter: AirPriceQualifiersType
-
Type: complexType
Description: Specifies passenger numbers and types.
In the Response
Optional
- Parameter: SeatsRequested
-
Type: nonNegativeInteger
Description: The sum of all seats required by all passenger groups.
In the Response
Optional
- Parameter: AirTravelerAvail
-
Type: TravelerInformationType
Description: Specifies passenger numbers and types.
In the Response
Optional
- Parameter: PriceRequestOptions
-
Type: PriceRequestOptionsType
Description: Identify pricing source, if negotiated fares are requested and if it is a reprice request.
In the Response
Optional
- Parameter: TravelerRating
-
Type: TravelerRatingType
Description: Customer Value Scores and Frequent Flyer Tiers for one traveler. It can influence Availability results when provided.
In the Response
Optional
- Parameter: GoverningCarrierOverride
-
Type: GoverningCarrierOverrideType
Description: Airline Carrier Code - override the GOVERNING CARRIER to get the fare filed by that carrier.
In the Response
Optional
- Parameter: VoluntaryChanges
-
Type: VoluntaryChangesSMPType
Description: Identifies whether penalties associated with voluntary changes should be included in the search results.
In the Response
Optional
- Parameter: RetailerRules
-
Type: RetailerRulesType
In the Response
Optional
- Parameter: TaxRules
-
Type: TaxRulesType
Description: Contains tax depending rules.
In the Response
Optional
- Parameter: ValidatingCarrier
-
Type: ValidatingCarrierType
Description: Validating carrier rule.
In the Response
Optional
- 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
In the Response
Optional
- 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.
In the Response
Optional
- Parameter: tripType
-
Type: AirTripType
Description: Specify air trip type.
In the Response
Optional
- Parameter: xOFares
-
Type: boolean
Description: XOFares indicator
In the Response
Optional
- Parameter: CarRateQualifiersType
-
Type: complexType
In the Response
Optional
- Parameter: Corporate
-
Type: complexType
In the Response
Optional
- Parameter: ID
-
Type: string
In the Response
Optional
- Parameter: CustLoyalty
-
Type: complexType
In the Response
Required
- Parameter: programID
-
Type: string
In the Response
Required
- Parameter: membershipId
-
Type: string
In the Response
Optional
- Parameter: GuaranteePrepaid
-
Type: complexType
In the Response
Optional
- Parameter: returnGuaranteedRates
-
Type: boolean
In the Response
Optional
- Parameter: returnPrepaidRates
-
Type: boolean
In the Response
Optional
- Parameter: returnRegularRates
-
Type: boolean
In the Response
Optional
- Parameter: ID
-
Type: complexType
In the Response
Optional
- Parameter: Number
-
Type: string
In the Response
Optional
- Parameter: Promotion
-
Type: complexType
In the Response
Optional
- Parameter: Code
-
Type: string
In the Response
Optional
- Parameter: type
-
Type: PromotionEnumtype
In the Response
Optional
- Parameter: RateCode
-
Type: string
In the Response
Optional
- Parameter: TourCode
-
Type: complexType
In the Response
Optional
- Parameter: Text
-
Type: string
In the Response
Optional
- Parameter: VehiclePreferences
-
Type: complexType
In the Response
Optional
- Parameter: Preference
-
Type: complexType
In the Response
Optional
- Parameter: VehicleType
-
Type: string
In the Response
Optional
- Parameter: LocationPreferences
-
Type: complexType
In the Response
Required
- Parameter: locationCode
-
Type: string
In the Response
Optional
- Parameter: cityLocation
-
Type: string
Note: Possible values are: "E:, "N", "S", "W", "C", "R", "A", "I", "P", "X", "H"
In the Response
Optional
- Parameter: VendorPreferences
-
Type: complexType
In the Response
Optional
- Parameter: VendorPreference
-
Type: complexType
In the Response
Required
- Parameter: code
-
Type: string
In the Response
Optional
- Parameter: exclude
-
Type: boolean
In the Response
Optional
- Parameter: SpecialEquipmentPreferences
-
Type: complexType
In the Response
Optional
- Parameter: Preference
-
Type: complexType
In the Response
Required
- Parameter: equipType
-
Type: string
In the Response
Optional
- Parameter: ccRate
-
Type: string
In the Response
Optional
- Parameter: commission
-
Type: boolean
In the Response
Optional
- Parameter: currencyCode
-
Type: string
In the Response
Optional
- Parameter: mileagePlan
-
Type: string
In the Response
Optional
- Parameter: rateAssured
-
Type: boolean
In the Response
Optional
- Parameter: rateCategory
-
Type: string
In the Response
Optional
- Parameter: ratePlan
-
Type: string
In the Response
Optional
- Parameter: HotelRateQualifiersType
-
Type: complexType
In the Response
Optional
- Parameter: RateAccessCode
-
Type: complexType
In the Response
Required
- Parameter: code
-
Type: string
In the Response
Optional
- Parameter: ContractNegotiatedRateCode
-
Type: string
In the Response
Optional
- Parameter: RatePlanCode
-
Type: complexType
In the Response
Optional
- Parameter: ValidatingCarrierType
-
Type: complexType
In the Response
Optional
- Parameter: Preference
-
Type: complexType
In the Response
Required
- Parameter: code
-
Type: CarrierCode
Description: Validating Carrier code
In the Response
Required
- Parameter: level
-
Type: ValidatingCarrierPreferLevelType
In the Response
Optional
- Parameter: TaxRulesType
-
Type: complexType
Description: Combines exemption rules connected with taxes.
In the Response
Optional
- Parameter: ExemptAllTaxes
-
Type: boolean
Description: Exempt all taxes (/TE)
In the Response
Optional
- Parameter: ExemptTax
-
Type: TaxCodeType
Description: Exempt Tax (/TE)
In the Response
Optional
- Parameter: RetailerRulesType
-
Type: complexType
In the Response
Required
- Parameter: RetailerRule
-
Type: complexType
In the Response
Required
- Parameter: code
-
Type: string
Description: pattern value=[0-9a-zA-Z]{2,20}
In the Response
Optional
- 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
In the Response
Optional
- Parameter: VoluntaryChangesSMPType
-
Type: complexType
Description: Specifies charges and/or penalties associated with making ticket changes after purchase.
In the Response
Optional
- Parameter: Penalty
-
Type: complexType
Description: Specifies penalty charges as either a currency amount or a percentage of the fare.
In the Response
Optional
- Parameter: type
-
Type: string
Description: Indicates the type (Refund or Exchange) of penalty involved in the search or response.
Note: Possible values are: "Refund" and "Exchange"
In the Response
Optional
- Parameter: exclude
-
Type: boolean
Description: Indicate that specific penalty type should be excluded from the response.
In the Response
Optional
- Parameter: application
-
Type: string
Description: Identifier used to indicate whether the change occurs before or after departure from the origin city.
Note: Possible values are: "After" and "Before"
In the Response
Optional
- Parameter: match
-
Type: string
Description: Indicates relation between conditions.
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
In the Response
Optional
- Parameter: GoverningCarrierOverrideType
-
Type: complexType
In the Response
Required
- Parameter: airlineCode
-
Type: CarrierCode
Description: Airline Carrier Code - override the GOVERNING CARRIER to get the fare filed by that carrier.
In the Response
Optional
- Parameter: TravelerRatingType
-
Type: complexType
Description: Customer Value Scores and Frequent Flyer Tiers for one traveler. It can influence Availability results when provided.
In the Response
Optional
- Parameter: Score
-
Type: ScoreType
In the Response
Optional
- Parameter: FrequentFlyer
-
Type: FrequentFlyerType
In the Response
Optional
- Parameter: ScoreType
-
Type: complexType
In the Response
Required
- Parameter: value
-
Type: integer
In the Response
Required
- Parameter: carrier
-
Type: string
In the Response
Optional
- Parameter: FrequentFlyerType
-
Type: complexType
In the Response
Required
- Parameter: tier
-
Type: integer
In the Response
Optional
- Parameter: NegotiatedFareCodeType
-
Type: complexType
In the Response
Optional
- Parameter: Supplier
-
Type: string
Description: This element indicates the supplier associated with a negotiated fare code.
In the Response
Optional
- Parameter: AccountCodeType
-
Type: complexType
In the Response
Optional
- Parameter: IndDefaultFalseType
-
Type: complexType
In the Response
Optional
- Parameter: ind
-
Type: boolean
In the Response
Optional
- Parameter: IndType
-
Type: complexType
In the Response
Optional
- Parameter: IndRequiredType
-
Type: complexType
In the Response
Required
- Parameter: ind
-
Type: boolean
In the Response
Optional
- Parameter: PriorityType
-
Type: complexType
In the Response
Required
- Parameter: priority
-
Type: int
In the Response
Optional
- Parameter: PriorityLegType
-
Type: complexType
In the Response
Optional
- Parameter: leg
-
Type: positiveInteger
In the Response
Optional
- Parameter: CarrierType
-
Type: complexType
In the Response
Required
- Parameter: Carrier
-
Type: complexType
Description: Specifies desired order of carriers
In the Response
Optional
- Parameter: PriorityComplexType
-
Type: complexType
In the Response
Optional
- Parameter: Price
-
Type: PriorityType
Description: Prefer cheaper itineraries
In the Response
Optional
- Parameter: DirectFlights
-
Type: PriorityLegType
Description: Prefer itineraries will less connections
In the Response
Optional
- Parameter: Time
-
Type: PriorityType
Description: Prefer itineraries departing closer to requested departure time
In the Response
Optional
- Parameter: Vendor
-
Type: PriorityType
Description: Promote certain marketing carriers over all the others in returning results. (configured in rules).
In the Response
Optional
- Parameter: MarketingCarrier
-
Type: CarrierType
Description: Prefer itineraries with marketing carriers in order speciied in Carrier subtags, comparing segment-wise
In the Response
Optional
- Parameter: OperatingCarrier
-
Type: CarrierType
Description: Prefer itineraries with operating carriers in order speciied in Carrier subtags, comparing segment-wise
In the Response
Optional
- Parameter: ElapsedTime
-
Type: PriorityType
Description: Prefer itineraries with shorter travel times
In the Response
Optional
- Parameter: DepartureTime
-
Type: PriorityLegType
Description: Prefer itineraries departing earlier during the day
In the Response
Optional
- Parameter: ConnectionTime
-
Type: PriorityLegType
Description: Prefer itineraries with smaller amount of time waiting in the airports during connections
In the Response
Optional
- Parameter: IndicatorsType
-
Type: complexType
In the Response
Optional
- 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.
In the Response
Optional
- 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.
In the Response
Optional
- 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.
In the Response
Optional
- Parameter: TravelPolicy
-
Type: IndRequiredType
Description: This element is currently ignored whether it is true or false.
In the Response
Optional
- Parameter: CustomerComplexType
-
Type: string
Note: Possible values are: "REGULAR" - Regular customer type.; "TVLYPREF" - TVLY_PREFERRED customer type.; "PREFELITE" - PREFERED_ELITE customer type.; "LOYALTY" - LOYALTY customer type.
In the Response
Optional
- Parameter: ItinerariesPerGroupType
-
Type: complexType
In the Response
Optional
- Parameter: itinerariesPerGroup
-
Type: int
Description: Indicates desired number of itineraries to be returned in each passenger group at begining of response.
In the Response
Optional
- Parameter: BrandedFareIndicatorsType
-
Type: complexType
In the Response
Optional
- Parameter: ReturnCheapestUnbrandedFare
-
Type: IndRequiredType
In the Response
Optional
- Parameter: singleBrandedFare
-
Type: boolean
Description: Return single brand option per itin
In the Response
Optional
- Parameter: multipleBrandedFares
-
Type: boolean
Description: Return multiple brand options per itin
In the Response
Optional
- Parameter: returnBrandAncillaries
-
Type: boolean
Description: Return ancillaries from the ATPCO Branded Fares Feature
In the Response
Optional
- Parameter: PassengerStatusEnumType
-
Type: string
Description: Possible values are: "R" - Residency; "E" - Employment; "N" Nationality
In the Response
Optional
- Parameter: PassengerStatusType
-
Type: complexType
In the Response
Optional
- Parameter: StateCode
-
Type: string
In the Response
Optional
- Parameter: CountryCode
-
Type: string
In the Response
Optional
- Parameter: CityCode
-
Type: AlphaLength3
In the Response
Required
- Parameter: type
-
Type: PassengerStatusEnumType
In the Response
Optional
- Parameter: ETicketableOverrideType
-
Type: complexType
In the Response
Optional
- Parameter: CurrencyType
-
Type: complexType
In the Response
Optional
- Parameter: dual
-
Type: AlphaLength3
Description: Dual currency
In the Response
Optional
- Parameter: mOverride
-
Type: boolean
Description: M override
In the Response
Optional
- Parameter: OBFeesType
-
Type: complexType
In the Response
Optional
- Parameter: rType
-
Type: boolean
Description: Indicator Returning R-Type OB Fees
In the Response
Optional
- Parameter: tType
-
Type: boolean
Description: Indicator Returning T-Type OB Fees
In the Response
Optional
- Parameter: FareAdjustmentType
-
Type: complexType
In the Response
Required
- Parameter: value
-
Type: string
Description: Adjustment Value, can be positive or negative, number or percentage
In the Response
Optional
- Parameter: currency
-
Type: AlphaLength3
Description: Currency of Adjustment's Value
In the Response
Optional
- Parameter: ValueType
-
Type: complexType
In the Response
Optional
- Parameter: value
-
Type: decimal
In the Response
Optional
- Parameter: PriceRequestOptionsType
-
Type: complexType
Description: Identify pricing source, if negotiated fares are requested and if it is a reprice request.
In the Response
Optional
- Parameter: NegotiatedFareCode
-
Type: NegotiatedFareCodeType
In the Response
Optional
- Parameter: AccountCode
-
Type: AccountCodeType
In the Response
Optional
- Parameter: PublicFare
-
Type: IndDefaultFalseType
Description: This element finds only public fares.
In the Response
Optional
- Parameter: PrivateFare
-
Type: IndDefaultFalseType
Description: This element finds only private fares.
In the Response
Optional
- Parameter: IATAFare
-
Type: IndDefaultFalseType
Description: This element finds only IATA fares.
In the Response
Optional
- Parameter: WebFare
-
Type: IndType
Description: Web fare
In the Response
Optional
- 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.
In the Response
Optional
- 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.
In the Response
Optional
- Parameter: PromoID
-
Type: string
Description: Promotional Identifier - a string which identifies a promotion, possibly giving a discount prices etc.
In the Response
Optional
- Parameter: CustomerType
-
Type: CustomerComplexType
In the Response
Optional
- Parameter: MultipleTravelerGroups
-
Type: ItinerariesPerGroupType
Description: This element governs how flights are returned when multiple passenger groups are requested.
In the Response
Optional
- Parameter: BrandedFareIndicators
-
Type: BrandedFareIndicatorsType
In the Response
Optional
- Parameter: PassengerStatus
-
Type: PassengerStatusType
In the Response
Optional
- 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.
In the Response
Optional
- Parameter: PointOfTicketingOverride
-
Type: string
In the Response
Optional
- Parameter: ApplyResidentDiscount
-
Type: boolean
Description: Apply resident discount in CLFE
In the Response
Optional
- Parameter: ETicketableOverride
-
Type: ETicketableOverrideType
In the Response
Optional
- Parameter: Currency
-
Type: CurrencyType
In the Response
Optional
- Parameter: UseReducedConstructions
-
Type: IndType
Description: Use reduced constructions (simple fare paths with restrictions on the number of fare components).
In the Response
Optional
- Parameter: OBFees
-
Type: OBFeesType
In the Response
Optional
- Parameter: FareBreaksAtLegs
-
Type: IndType
Description: Force fare breaks at leg points if split taxes by leg requested. By default set to true.
In the Response
Optional
- Parameter: FareAdjustment
-
Type: FareAdjustmentType
Description: Capability to specify Plus-Up and Discount Amount and Percentage.
In the Response
Optional
- Parameter: ForceCompanion
-
Type: ValueType
Description: Force companion fare value.
In the Response
Optional
- Parameter: UsePassengerFares
-
Type: IndRequiredType
Description: At least one fare component for each passenger type must be applicable for that passenger type.
In the Response
Optional
- Parameter: UseNegotiatedFares
-
Type: IndRequiredType
Description: At least one fare component for each passenger type must be applicable for that passenger type.
In the Response
Optional
- Parameter: UseNegotiatedFares
-
Type: IndRequiredType
Description: Returned fares need to match AcccountCode/CorporateID on at least one fare component.
In the Response
Optional
- Parameter: negotiatedFaresOnly
-
Type: boolean
Description: If set to true then returned fares need to match requested AcccountCode/CorpID on all fare components
In the Response
Optional
- Parameter: currencyCode
-
Type: AlphaLength3
Description: Type of funds preferred for reviewing monetary values, in ISO 4217 codes.
In the Response
Optional
- Parameter: pricingSource
-
Type: RequestPricingSourceType
Description: It can be used to indicate whether the fare is public or private.
In the Response
Optional
- Parameter: reprice
-
Type: boolean
In the Response
Optional
- Parameter: processThruFaresOnly
-
Type: boolean
Description: Activates processing of thru fares only.
In the Response
Optional
- Parameter: purchaseDate
-
Type: date
Description: Specify purchase date. Fares returned will be based on the purchase date.
In the Response
Optional
- Parameter: purchaseTime
-
Type: string
Description: Specify purchase time. Fares returned will be based on the purchase time.
In the Response
Optional
- Parameter: netFaresUsed
-
Type: boolean
Description: Set to true when exchange ticket uses net fare.
In the Response
Optional
- Parameter: RequestPricingSourceType
-
Type: string
Description: It can be used to indicate whether the fare is public or private.
Note: Possible values are: "Published", "Private", "Both"
In the Response
Optional
- Parameter: secondaryCode
-
Type: string
Description: An additional attribute to allow flexibility for particular organizations who require an additional code.
In the Response
Optional
- Parameter: supplierCode
-
Type: string
Description: An additional attribute to allow flexibility for particular organizations who require an additional supplier code.
In the Response
Optional
- Parameter: codeContext
-
Type: string
Description: Identifies the source authority for the code.
In the Response
Optional
- Parameter: URI
-
Type: anyURI
Description: Identifies the location of the code table
In the Response
Optional
- Parameter: quantity
-
Type: int
Description: Specifies the number of items that are identified by the Code (e.g., 2 adults, 5 first class seats).
In the Response
Optional
- Parameter: TravelerInformationType
-
Type: complexType
Description: Specifies passenger numbers and types.
In the Response
Optional
- Parameter: PassengerTypeQuantity
-
Type: PassengerTypeQuantityType
Description: Specifies number of passengers using Passenger Type Codes.
In the Response
Optional
- 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.
In the Response
Optional
- 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.
In the Response
Optional
- Parameter: CustLoyalty
-
Type: CustLoyaltyType
Description: Specify a customer loyalty program.
In the Response
Optional
- Parameter: PassengerTypeQuantity
-
Type: PassengerTypeQuantityType
Description: Define information on the number of passengers of a specific type.
In the Response
Optional
- Parameter: TravelerRefNumber
-
Type: TravelerRefNumberType
Description: Direct reference of traveler assigned by requesting system. Used as a cross reference between data segments.
In the Response
Optional
- Parameter: FlightSegmentRPHs
-
Type: FlightSegmentRPHsType
Description: Reference pointers to flight segments
In the Response
Optional
- Parameter: currencyCode
-
Type: AlphaLength3
Description: The preferred currency in which monetary amounts should be returned.
In the Response
Required
- Parameter: passengerTypeCode
-
Type: AlphaLength3
Description: A three-letter code representing passenger type (e.g. .ADT. for adult, .CNN. for child)
In the Response
Optional
- Parameter: accompaniedByInfant
-
Type: boolean
Description: Indicates if an infant accompanying a traveler is with or without a seat.
In the Response
Optional
- Parameter: FlightSegmentRPHsType
-
Type: complexType
In the Response
Optional
- Parameter: FlightSegmentRPH
-
Type: string
Description: Reference to the flight segments for this traveler
In the Response
Optional
- Parameter: TravelerRefNumberType
-
Type: complexType
Description: A reference place holder used as a pointer to link back to the traveler.
In the Response
Optional
- Parameter: RPH
-
Type: string
Description: Reference place holder.
In the Response
Optional
- Parameter: CustLoyaltyType
-
Type: complexType
Description: Program rewarding frequent use by accumulating credits for services provided by vendors.
In the Response
Optional
- Parameter: programID
-
Type: string
Description: Identifier to indicate the company owner of the loyalty program.
In the Response
Optional
- Parameter: membershipID
-
Type: string
Description: Unique identifier of the member in the program (membership number, account number, etc.).
In the Response
Optional
- Parameter: travelSector
-
Type: string
Description: Identifies the travel sector. Refer to OTA Code List Travel Sector (TVS).
In the Response
Optional
- Parameter: loyalLevel
-
Type: string
In the Response
Optional
- Parameter: singleVendorInd
-
Type: SingleVendorIndType
In the Response
Optional
- Parameter: signupDate
-
Type: date
In the Response
Optional
- Parameter: RPH
-
Type: string
Description: Reference place holder, to reference it back in the response.
In the Response
Optional
- Parameter: SingleVendorIndType
-
Type: simpleType
Description: Indicates if program is affiliated with a group of related offers accumulating credits.
Note: Possible values are: "SingleVndr" and "Alliance"
In the Response
Optional
- Parameter: PassengerTypeQuantityType
-
Type: complexType
Description: Specifies a PTC (Passenger Type Code) and the associated number of PTC's - for use in specifying passenger lists.
In the Response
Optional
- Parameter: BirthDate
-
Type: BirthDateType
In the Response
Optional
- Parameter: Age
-
Type: AgeType
Description: Exchange-specific
In the Response
Optional
- Parameter: State
-
Type: StateType
Description: Exchange-specific
In the Response
Optional
- Parameter: TotalNumber
-
Type: TotalNumberType
Description: Exchange-specific
In the Response
Optional
- Parameter: changeable
-
Type: boolean
In the Response
Optional
- Parameter: index
-
Type: int
Description: Allows to identify which one of requested passengers this solution relates to.
In the Response
Optional
- Parameter: requestedPassengerIndex
-
Type: nonNegativeInteger
Description: Allows to identify which one of requested passenger groups from Exchange request this solution relates to.
In the Response
Optional
- Parameter: BirthDateType
-
Type: complexType
In the Response
Optional
- Parameter: date
-
Type: date
In the Response
Optional
- Parameter: AgeType
-
Type: complexType
In the Response
Required
- Parameter: years
-
Type: short
In the Response
Optional
- Parameter: StateType
-
Type: complexType
In the Response
Optional
- Parameter: TotalNumberType
-
Type: complexType
In the Response
Optional
- Parameter: AlphaLength3
-
Type: string
Description: Used for Alphabetic Strings, length exactly 3
Note: pattern value="[a-zA-Z]{3}"
In the Response
Optional
- 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).
In the Response
Optional
- Parameter: URI
-
Type: anyURI
Description: Identifies the location of the code table
In the Response
Optional
- Parameter: quantity
-
Type: int
Description: Specifies the number of travelers.
In the Response
Optional
- Parameter: DecimalPrice
-
Type: complexType
Description: Provides a monetary amount and the currency code to reflect the currency in which this amount is expressed.
In the Response
Required
- Parameter: currencyCode
-
Type: CurrencyCodeType
In the Response
Optional
- Parameter: TaxCodeType
-
Type: complexType
Description: Defines the data fields available for tax code.
In the Response
Required
- Parameter: taxCode
-
Type: string
Description: Identifies the code for the tax.
In the Response
Optional
- Parameter: CabinPrefType
-
Type: complexType
Description: Indicates preferences for choice of airline cabin for a given travel situation.
In the Response
Optional
- Parameter: preferLevel
-
Type: PreferLevelType
Description: Used to indicate a level of preference for an associate item, only, unacceptable, preferred.
In the Response
Optional
- Parameter: cabin
-
Type: CabinNameType
Description: Specify cabin type
In the Response
Optional
- Parameter: CabinNameType
-
Type: NMTOKEN
Description: cabin is either Premium First (P), First (F), Premium Business (J), Business (C), Premium Economy (S) or Economy (Y)
Note: Possible values are: "PremiumFirst", "First", "PremiumBusiness", "Business", "PremiumEconomy", "Economy", "Y", "S", "C", "J", "F", "P"
In the Response
Optional
- 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.).
Note: Possible values are: "Only", "Unacceptable", "Preferred"
In the Response
Optional
- Parameter: Money
-
Type: decimal
Description: Used for amounts, max 3 decimals
In the Response
Optional
- Parameter: currencyCode
-
Type: CurrencyCodeType
Description: A currency code (e.g. USD, EUR, PLN)
In the Response
Optional
- 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".
In the Response
Optional
- Parameter: amount
-
Type: Money
In the Response
Optional
- Parameter: CurrencyCodeType
-
Type: simpleType
Description: Used for Currency Codes
In the Response
Optional
- Parameter: CarrierCode
-
Type: string
Note: pattern value="[0-9A-Z]{2,3}
In the Response
Optional
- Parameter: AirTripType
-
Type: string
Description: Identifies the trip type - one way, return, circle trip, open jaw.
Note: Possible values are: "OneWay", "Return", "Circle", "OpenJaw", "Other"
In the Response
Optional
- Parameter: ValidatingCarrierPreferLevelType
-
Type: NMTOKEN
Description: Used to specify a preference level for ValidatingCarrier. For adding new enums see PreferLevelType.
Note: Possible values are: "Unacceptable", "Preferred"