v1.19.16 | June 1, 2022
- Ability to add a new IUR attribute during CSL segment creation.
API Information
What's New
- Ability to add a new IUR attribute during CSL segment creation.
New Features
In the Request/Response
Optional
- Parameter: LegacyCompatible
-
Type: boolean
Description: The new IUR attribute ("LegacyCompatible") is valid for GDS bookings only. This parameter is stored within segment details with a default value of "False". This parameter is available in the request and in the response: RQ: ReservationUpdateList/ReservationUpdateItem/ProductUpdate/Product/or:ProductDetails/or:Lodging/@LegacyCompatible RS: Reservation/PassengerReservation/Segments/Product/ns1:ProductDetails/ns1:Lodging/@LegacyCompatible
Sample Value:
RQ:
<ProductUpdate op="C">
<Product>
<or:ProductDetails xmlns:or="http://services.sabre.com/res/or/v1_14">
<or:ProductName type="HHL">Lodging</or:ProductName>
<or:Lodging LegacyCompatible="true">
<or:ResGlobalInfo>
<or:BookingInfo
Email="Orville.Wright@sabre.com"
RequestorID="SG000000">
<or:BookingKey>6fcba3a0-d52a-4d3a-a10c-2fe11bca63de</or:BookingKey>
</or:BookingInfo>
</or:ResGlobalInfo>
...
RS:
<or114:ProductDetails productCategory="AGTLCSSEGMENT" productType="HHL" vendorCode="RT" statusCode="HK" startPoint="SYD" startDateTime="2022-09-13T00:00:00" endPoint="SYD" endDateTime="2022-09-15T00:00:00">
<or114:ProductName type="HHL">Lodging</or114:ProductName>
<or114:Lodging LegacyCompatible="true">
<or114:ResGlobalInfo>
<or114:BookingInfo Status="39" RequestorID="SG000000" InfoSource="100" TransactionId="IHFVIK0101653055002500" Email="Orville.Wright@sabre.com">
<or114:BookingKey>6fcba3a0-d52a-4d3a-a10c-2fe11bca63de</or114:BookingKey>
...Note:
Relase note ID: 17300
v1.19.0 | August 16, 2018
- Ability to mark PNRs as suspicious
- Informational segment flag inclusion
- New capabilities for hotel content (CRUD)
- Ability to choose PQ (GetPriceQuoteRQ) service version
- Support for meal codes within Air segment
- Support for PrimeHostID field
- Support for FileName field
- New flexible way of using Views and Subject Areas
API Information
What's New
- Ability to mark PNRs as suspicious
- Informational segment flag inclusion
- New capabilities for hotel content (CRUD)
- Ability to choose PQ (GetPriceQuoteRQ) service version
- Support for meal codes within Air segment
- Support for PrimeHostID field
- Support for FileName field
- New flexible way of using Views and Subject Areas
Functional Updates And Enhancements
In the Request
Optional
- Parameter: PriceQuoteServiceVersion
-
Type: string
Description: Defines version of service used to obtain Price Quote content.
Sample Value:
3.2.0Note:
In the Request/Response
Optional
- Parameter: RPH
-
Type: string
Description: The Reference Place Holder (RPH) is an index code used to identify an instance in a collection of like items (e.g. used to assign individual passengers or clients to particular itinerary items).
Sample Value:
001Note:
In the Request/Response
Optional
- Parameter: NameNumber
-
Type: string
Description: "NameNumber" is used to associate the particular frequent flyer number to a particular passenger within the record.
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: File
-
Type:
Description: "File" is used to return the file name/identifier
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ProductCode
-
Type: string
Description: "ProductCode" is used to return the product code.
Sample Value:
Note:
In the Response
Optional
- Parameter: FileInfo
-
Type: FileInfo.PNRB
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Changed
-
Type: string
Description: "Changed" is used to indicate if the passenger's seat as been changed.
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: NameNumber
-
Type: string
Description: "NameNumber" is used return the passenger name number associated with the particular seat reservation.
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: PrimeHostID
-
Type: string
Description: An identification code assigned to the GDS.
Sample Value:
1SNote:
In the Response
Optional
- Parameter: CheckInAirline
-
Type: complex type
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: BaggageAllowance
-
Type: BaggageAllowance
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Number
-
Type: string
Description: "Number" is used to return the baggage allowance type associated with the particular flight segment.
Sample Value:
Note:
In the Response
Optional
- Parameter: Informational
-
Type: boolean
Description: Informational segment indicator
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: OfferItemID
-
Type: string
Description: Offer Item Id from the offer store
Sample Value:
Note:
In the Response
Optional
- Parameter: Candidate
-
Type: boolean
Description: Indicator for potential PNR booking for further review
Sample Value:
Note:
In the Response
Optional
- Parameter: Reporter
-
Type: string
Description: TN or Airline Code reporting potential PNR booking for further review
Sample Value:
Note:
In the Response
Optional
- Parameter: Value
-
Type: int
Description: TN or Airline Code reporting potential PNR booking for further review
Sample Value:
Note:
In the Response
Optional
- Parameter: Description
-
Type: string
Description: Short description of reason for reporting potential PNR booking for further review
Sample Value:
Note:
In the Response
Optional
- Parameter: SpecialEquipment
-
Type: string
Description: Special equipment code. ex. PHN for Mobile Phone
Sample Value:
Note:
In the Response
Optional
- Parameter: codeContext
-
Type: string
Description: Holds context, where passenger code is defined, ex. ATPC
Sample Value:
Note:
In the Response
Optional
- Parameter: ValidatingCarrier
-
Type: AirlineCode
Description: IATA Code of ticketing carrier (carrier issuing a ticket and holding settlements) ex. "AA". It is used for informational purposes only. To enforce Validating Carried during pricing process "ValidatingCarrier" Air qualifier should be used.
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AncillarySequenceNumber
-
Type: string
Description: "AncillarySequenceNumber" contains ancillary sequence number. Maps to Ancillary/SequenceNumber in GAO
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: OfferItemID
-
Type: string
Description: "OfferItemID" contains information about Offer Item Id from the offer store.
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BagOccurence
-
Type:
Description: "BagOccurence" contains information about Number of occurrences of a given bag ancillary subcode within a PNR
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceQuote
-
Type: PriceQuoteType
Description: Contains PriceQuoteInfo returned from GetPriceQuoteRS
Sample Value:
Note:
In the Request
Optional
- Parameter:
-
Type:
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: OfferID
-
Type: string
Description: Offer Id from the offer store
Sample Value:
Note:
In the Request/Response
Required
- Parameter: Lodging
-
Type: LodgingProductType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ResGlobalInfo
-
Type: ResGlobalInfoType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BookingInfo
-
Type: BookingInfoRefType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Status
-
Type: string
Description: Uses STS OTA Code Table
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RequestorID
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CorpDiscount
-
Type: MembershipIdType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: PromotionalCode
-
Type: MembershipIdType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CreationDate
-
Type: date
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ExistingItinerary
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: InfoSource
-
Type: string
Description: Booking source will be 3 character numeric code
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RateKey
-
Type: SabreKeyType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: TransactionId
-
Type: string
Description: This is unique transaction id generated by hotels and should be provided on retries
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RetransmissionIndicator
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Email
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: FrequentFlyerNumber
-
Type: MembershipIdType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: LoyaltyId
-
Type: MembershipIdType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: HotelInfo
-
Type: HotelInfoType
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: HotelCode
-
Type: string
Description: Hotel Id from SABRE hotels platform
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: GlobalChainCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: HotelName
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CodeContext
-
Type: string
Description: SABRE OR GLOBAL
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BrandCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SabreRating
-
Type: RatingType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ChainName
-
Type: StringLength0to500
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BrandName
-
Type: StringLength0to500
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SupplierChainCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SourceHotelCode
-
Type: string
Description: Supplier/Source Hotel Id
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: TierLabels
-
Type: TierLabels
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: TierLabel
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Type
-
Type: StringLength0to500
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Value
-
Type: StringLength0to500
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: LocationInfo
-
Type: LocationInfo
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Latitude
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Longitude
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Address
-
Type: LodgingAddressType
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: AddressLine1
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AddressLine2
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AddressLine3
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CityName
-
Type: CityCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: StateProv
-
Type: StateProv
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: PostalCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: CountryName
-
Type: CountryName
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CityCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: StateCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: Code
-
Type: CountryCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Contact
-
Type: ContactType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Phone
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Mobile
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Fax
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Amenities
-
Type: Amenities
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Amenity
-
Type: Amenity
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Code
-
Type: OTACodeType
Description: Uses HAC table for OTA mapped codes and description. ComplimentaryInd - true : Attribute is not displayed in response as Amenity has no additional charge and it is complimentary false : Amenity has additional charge and appropriately indicated
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Description
-
Type: OTATypeDescription
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ComplimentaryInd
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: StayDateRange
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: StartDate
-
Type: date
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: EndDate
-
Type: date
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Total
-
Type: TotalCharges
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AmountAfterTax
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AmountBeforeTax
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Changed
-
Type: boolean
Description: Denotes that total is changed since shopping
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BalanceAmount
-
Type: MoneyDataType
Description: Some aggregators return a balance amount that needs to be paid after cancellation
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SupplierChangedAmount
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AdditionalDetails
-
Type: AdditionalDetailsType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AdditionalDetail
-
Type: AdditionalDetailType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Code
-
Type: OTACodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: GuestCount
-
Type: int
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: StartDate
-
Type: date
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: EndDate
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: NumberOfNights
-
Type: int
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Text
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Fees
-
Type: FeesType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Fee
-
Type: LodgingFeeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Code
-
Type: OTACodeType
Description: OpenTravel Code List Fee Tax Type (FIT)
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ApplyAs
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BasisType
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: FeeDescription
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Text
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Taxes
-
Type: LodgingTaxesType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Tax
-
Type: LodgingTaxesType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: TaxDescription
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CancelPenalties
-
Type: CancelPenalties
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CancelPenalty
-
Type: CancelPenalty
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Refundable
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Deadline
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AbsoluteDeadline
-
Type: dateTime
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: OffsetDropTime
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: OffsetTimeUnit
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: OffsetUnitMultiplier
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AmountPercent
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: TaxInclusive
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: FeesInclusiv
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: NmbrOfNights
-
Type: int
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BasisType
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Percent
-
Type: Percentage
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ApplyAs
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: PenaltyDescription
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Guarantee
-
Type: GuaranteeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: GuaranteeType
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: GuaranteesAccepted
-
Type: GuaranteeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: GuaranteeAccepted
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: GuaranteeTypeCode
-
Type: OTACodeType
Description: Uses OTA for PMT Table
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: PaymentCard
-
Type: string
Description: The Card like Credit card or debit card which is used to pay
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CardCode
-
Type: PaymentCardCodeType
Description: Code identifying the card type
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: GuaranteeDescription
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Commission
-
Type: CommissionType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CommissionIndicator
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Type
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CommissionDescription
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Discounts
-
Type: Discounts
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Discount
-
Type: Discount
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Code
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Name
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Rooms
-
Type: Rooms
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: NumberOfRooms
-
Type: int
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: GuestCount
-
Type: int
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: Room
-
Type: RoomInformation
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: NonSmoking
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BedTypeCode
-
Type: TACodeType
Description: OTA Type Codes , Uses BED Table
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AccessibilityInformation
-
Type: OTACodeType
Description: OTA Types Code, Uses PHY table
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomIndex
-
Type: IndexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomTypeCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomTypeCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomType
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: InvBlockCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomCategory
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomId
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SegmentNumber
-
Type: int
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Floor
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomViewCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SharedRoomInd
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Action
-
Type: UpdateActionCodeForRoom
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Guests
-
Type: Guests
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Guest
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Title
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: FirstName
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: LastName
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Email
-
Type: EmailType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Age
-
Type: string
Description: Age is mandatory for a child
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Index
-
Type: IndexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: LeadGuest
-
Type: boolean
Description: Only one lead passenger per booking
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: FrequentFlyerNumber
-
Type: MembershipIdType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: LoyaltyId
-
Type: MembershipIdType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: FullName
-
Type: In response sometimes aggregator does not return first name / last name and only full name is returned
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Type
-
Type: OTACodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Contact
-
Type: ContactType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomDescription
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Text
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Name
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomExtras
-
Type: RoomExtras
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RoomExtra
-
Type: RoomExtra
Description: For adding extras to a Room
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Quantity
-
Type: string
Description: Quantity for room extras. Mandatory for request
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Type
-
Type: OTACodeType
Description: Uses RMA OTA Table. Only 3 supported CRIB/Rollaway bed/Extra person
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ConfirmationCode
-
Type: string
Description: Room level Booking Confirmation Code if it exists
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CancellationCode
-
Type: string
Description: Room Level Cancellation Code if it exists
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BookingStatus
-
Type: string
Description: Room Level Booking Status
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RatePlan
-
Type: RatePlanType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RatePlanName
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RatePlanCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SupplierRatePlanCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RatePlanType
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: PrepaidIndicator
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RateAssured
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RatePlanDescription
-
Type: RatePlanDescriptionType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RatePlanInclusions
-
Type: RatePlanInclusionsType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RatePlanInclusionDescription
-
Type: RatePlanInclusionDescriptionType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: MealsIncluded
-
Type: MealsIncludedType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: MealIncluded
-
Type: MealIncludedType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Breakfast
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Lunch
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Dinner
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: MealPlanIndicator
-
Type: boolean
Description: When true Meal Plan is include
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: MealPlanCode
-
Type: string
Description: Used to Identify the types of meals included. Refer to Open Travel Code List Meal Plan Type (MPT) list of codes
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RateInfo
-
Type: RateInfoType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AmountBeforeTax
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AmountAfterTax
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AppliedDiscount
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: NightlyRate
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AdditionalFeesExcludedIndicator
-
Type: boolean
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SupplierChangedAmount
-
Type: MoneyDataType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Rates
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: Rates
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ValueAdds
-
Type: ValueAdds
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: ValueAdd
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SpecialInstructions
-
Type: SpecialInstructions
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: SpecialInstruction
-
Type: SpecialInstruction
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: SearchParameters
-
Type: LodgingSearchParameters
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: SearchParameter
-
Type: AttributeType
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: Value
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: Type
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: PaymentInformation
-
Type: LodgingPaymentInformation
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: FormOfPaymentReference
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ref
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: newRef
-
Type:
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: deploymentId
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: POS
-
Type: LodgingPOSType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Source
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AgencyName
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AgentSine
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AgentDutyCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Lniata
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AgentOriginCity
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ISOCountryCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: ISOCurrencyCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AuxPlaceOfOrigin
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: IATAOriginatorTypeCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CreationDate
-
Type: date
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CreationTime
-
Type: time
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: PseudoCityCode
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: RequestorID
-
Type: IATA ID is mandatory for GDS Booking
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Type
-
Type: OTACodeType
Description: OTA Table UIT : Value 5 for travel agency
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Id
-
Type: string
Description: Agency IATA ID
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: IdContext
-
Type: string
Description: Value : IATA
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AgencyAddress
-
Type: LodgingAddressType
Description: Agency Address is mandatory for GDS Booking
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AgencyContact
-
Type: ContactType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: VoucherInformation
-
Type: VoucherInformation
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: OfficialSupplierName
-
Type: string
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: VoucherAttributes
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: VoucherAttribute
-
Type: AttributeType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: VoucherDetails
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Required
- Parameter: VoucherDetail
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ODReevalAtETData
-
Type: string
Description: Stores the origin-destination reevaluation data provided by SSI at end transaction(ET1.5) for a given segment. Data in this element will only be available to IX via ASDS.
Sample Value:
Note:
In the Response
Required
- Parameter: Error
-
Type: short
Description: An error code if the segment in the PNR has failed during reevaluation.
Sample Value:
Note:
In the Response
Required
- Parameter: ReevaluationMap
-
Type: long
Description: An informational field that stores data about the reevaluation.
Sample Value:
Note:
In the Response
Required
- Parameter: AvailableSeats
-
Type: short
Description: Availability at the time of end transaction.
Sample Value:
Note:
Relase note ID: 12870
v1.18.0 | February 21, 2018
- Support for new FOP type: AccountCode
- Support for Corporate ID with New Payment Card (WS)
- FCMI functionality - price validation on SellCancel
API Information
What's New
- Support for new FOP type: AccountCode
- Support for Corporate ID with New Payment Card (WS)
- FCMI functionality - price validation on SellCancel
Functional Updates And Enhancements
In the Request/Response
Optional
- Parameter: FareCalculationModeIndicator
-
Type: FCMIType
Description: 0 - system priced, 1 - Manually priced, 2 - system priced, but tax data manipulated
Sample Value:
Note:
In the Request
Optional
- Parameter: FareCalculationPriceIndicator
-
Type: FCMIType
Description: 0 = system computer priced (without any manual modifications except for baggage allowance), 1 = manually priced, 2-9 = for individual airline/system provider use, A-Z = undefined industry use
Sample Value:
Note:
In the Response
Optional
- Parameter: FCMIType
-
Type: int
Description: possible values: 0 / 1/ 2
Sample Value:
Note:
In the Response
Optional
- Parameter: FCMIType
-
Type: int
Description: pattern value="[0-9A-Z]"
Sample Value:
Note:
In the Response
Optional
- Parameter: DayOfWeekInd
-
Type: string
Description: "DayOfWeekInd" is used to return the day of the week indicator.
Sample Value:
Note:
In the Response
Optional
- Parameter: NumberInParty
-
Type: string
Description: "NumberInParty" is used to return the number of passengers associated with the particular hotel segment.
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AccountCode
-
Type: complex Type
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Custom
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: MaxDurationDays
-
Type: string
Description: Max duration associated with annual multi trip product.
Sample Value:
Note:
In the Request
Optional
- Parameter: OpenReservationAction
-
Type: complexType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: PaymentCardApprovalAction
-
Type: PaymentCardApprovalAction
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: PaymentCardCorporateIDAction
-
Type: PaymentCardCorporateIDAction
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: PaymentCardApprovalAction
-
Type: complexType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: PaymentCardApproval
-
Type: PaymentCardApproval
Description:
Sample Value:
Note:
In the Request
Required
- Parameter: fopElementId
-
Type: string
Description:
Sample Value:
Note:
In the Request
Required
- Parameter: op
-
Type: OpenReservationOperation
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: PaymentCardCorporateIDAction
-
Type: complexType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: CorporateIDNumber
-
Type: string
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: OpenReservationOperation
-
Type: string
Description: Possible values: CREATE / UPDATE / DELETE
Sample Value:
Note:
In the Response
Optional
- Parameter: CardHolderInfo.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: AddressLines
-
Type: AddressLines.PNRB
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: AirExtras
-
Type: boolean
Description: "AirExtras" is used to indicate whether or not air extra-related information pertains to the particular record.
Sample Value:
Note:
In the Response
Optional
- Parameter: InhibitCode
-
Type: string
Description: "InhibitCode" is utilized to return the viewership code associated with the particular record.
Sample Value:
Note:
In the Response
Optional
- Parameter: dayOfWeekInd
-
Type: string
Description: "DayOfWeekInd" is used to return the day of the week indicator.
Sample Value:
Note:
In the Response
Optional
- Parameter: EquipmentType
-
Type: string
Description: "EquipmentType" is used to return the aircraft equipment type associated with the particular flight segment.
Sample Value:
Note:
In the Response
Optional
- Parameter: Banner
-
Type: string
Description: "Air/Banner" is used to return the marketing airline name.
Sample Value:
Note:
In the Response
Optional
- Parameter: Code
-
Type: string
Description: "Code" is used to return the operating airline code used for pricing associated with the particular flight segment.
Sample Value:
Note:
In the Response
Optional
- Parameter: CodeShare
-
Type: boolean
Description: "CodeShare" is used to indicate if this is a codeshare flight.
Sample Value:
Note:
In the Response
Optional
- Parameter: SpecialMeal
-
Type: boolean
Description: "SpecialMeal" is used to indicate whether or not a special meal is associated with the particular flight segment.
Sample Value:
Note:
In the Response
Optional
- Parameter: SmokingAllowed
-
Type: boolean
Description: "SmokingAllowed" is used to indicate whether or not smoking is permitted on the particular flight segment.
Sample Value:
Note: Set to false by default
In the Response
Optional
- Parameter: ResBookDesigCode
-
Type: string
Description: "ResBookDesigCode" is used to specify the booking class.
Sample Value:
Note:
In the Response
Optional
- Parameter: StopQuantity
-
Type: string
Description: "StopQuantity" is used to return the number of stops associated with the particular flight segment.
Sample Value:
Note:
In the Response
Optional
- Parameter: Code
-
Type: string
Description: "Code" is used to return the meal code associated with the particular flight segment if applicable.
Sample Value:
Note:
In the Request
Optional
- Parameter: OtherAirlineSign
-
Type: CommonString
Description: Other airline sign information
Sample Value:
Note:
In the Response
Optional
- Parameter: RefundResult
-
Type: RefundResult.PNRB
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: BookAndHoldResult
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: AirlineCode
-
Type: AirlineCode
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Status
-
Type: complexType
Description: Result of holding a booking for a given airline; SUCCESS, FAILURE
Sample Value:
Note:
In the Response
Optional
- Parameter: message
-
Type: string
Description: Additional information of the holding result
Sample Value:
Note:
In the Request
Optional
- Parameter: CarrierRefundItem.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: CarrierRecordLocator
-
Type: string
Description: Determines which segments will be refunded
Sample Value:
Note:
In the Request
Optional
- Parameter: SegmentSubset
-
Type: SegmentSubset
Description: Tries to refund all possible segments
Sample Value:
Note:
In the Request
Optional
- Parameter: PaymentAuthorizationCode
-
Type: string
Description: Code needed to handle payment processing
Sample Value:
Note:
In the Request
Optional
- Parameter: SegmentSubset
-
Type: string
Description: Tries to refund all possible segments
Sample Value:
Note:
In the Response
Optional
- Parameter: RefundResult.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CarrierRefund
-
Type: CarrierRefund.PNRB
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: WarningCarrierRefund
-
Type: WarningCarrierRefund.PNRB
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: CarrierRefund.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: Amount
-
Type: string
Description: Determines amount that will be refund
Sample Value:
Note:
In the Request
Optional
- Parameter: CarrierCode
-
Type: string
Description: Determines segment carrier that will be refund
Sample Value:
Note:
In the Request
Optional
- Parameter: Currency
-
Type: string
Description: Currency amount that will be refund
Sample Value:
Note:
In the Response
Optional
- Parameter: WarningCarrierRefund.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CarrierCode
-
Type: string
Description: Determines segment carrier that will not be refund
Sample Value:
Note:
In the Response
Optional
- Parameter: Message
-
Type: string
Description: Determines the cause, why segments for carrier can not be refund
Sample Value:
Note:
In the Request
Optional
- Parameter: BookAndHoldType.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: AirlineCode
-
Type: AirlineCode
Description: Determines airline whose segments should be held. If not provided, all eligible segments will be held.
Sample Value:
Note:
In the Request
Optional
- Parameter: ExemptAllTaxesAndFees
-
Type: boolean
Description: Exempt all taxes and fees (/TN)
Sample Value:
Note:
Relase note ID: 12922
v1.17.0 | November 16, 2017
- Book and Hold functionality for Low Cost Carriers
- Extended insurance product for annual multi trip
- COS functionality - support for shortSell and longSell functionalities
- Support for Manual Update fields in RES ORR
API Information
What's New
- Book and Hold functionality for Low Cost Carriers
- Extended insurance product for annual multi trip
- COS functionality - support for shortSell and longSell functionalities
- Support for Manual Update fields in RES ORR
New Features
In the Response
Optional
- Parameter: Cabin
-
Type: CabinType
Description: Generic cabin description data
Sample Value:
Note:
In the Response
Optional
- Parameter: MealCode
-
Type: string
Description: Meal code associated with the particular flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: SmokingAllowed
-
Type: boolean
Description: Indicates whether or not smoking is permitted on the particular flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: StopQuantity
-
Type: int
Description: Number of stops associated with the particular flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: ElapsedTime
-
Type: int
Description: The elapsed time in minutes associated with the particular flight segment
Sample Value:
Note:
In the Request
Optional
- Parameter: AirMilesFlown
-
Type: int
Description: Air miles flown associated with the particular flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: HiddenStop
-
Type: complexType
Description: Used to return hidden stop details
Sample Value:
Note:
In the Response
Optional
- Parameter: ArrivalDateTime
-
Type: string
Description: Arrival date and time to hidden stop
Sample Value:
Note:
In the Response
Optional
- Parameter: DepartureDateTime
-
Type: string
Description: Departure date and time from hidden stop
Sample Value:
Note:
In the Response
Optional
- Parameter: Airport
-
Type: string
Description: "Airport" is used to determine airport location code
Sample Value:
Note:
In the Response
Optional
- Parameter: FunnelFlight
-
Type: boolean
Description: "FunnelFlight" is used to determine a funnel flight type for flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: ChangeOfGauge
-
Type: boolean
Description: "ChangeOfGauge" is used to determine a change of gauge for flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: DisclosureCarrier
-
Type: complexType
Description: Disclosure Carrier is used to return operated flight data
Sample Value:
Note:
In the Response
Optional
- Parameter: Banner
-
Type: string
Description: "DisclosureCarrier/Banner" is used to return the disclosure carrier name
Sample Value:
Note:
In the Response
Optional
- Parameter: Code
-
Type: string
Description: "Code" is used to return the disclosure carrier code associated with the particular vehicle segment
Sample Value:
Note:
In the Response
Optional
- Parameter: DOT
-
Type: boolean
Description: "DOT" is optional data from DSS (DOT) it determines Banner appearance
Sample Value:
Note:
In the Response
Optional
- Parameter: FareComponent
-
Type: FareComponentWithId
Description: Fare Component information
Sample Value:
Note:
In the Response
Optional
- Parameter: CabinType
-
Type: complexType
Description: Cabin data form ATPCO RBD Answer Table (A02 record)
Sample Value:
Note:
In the Response
Optional
- Parameter: code
-
Type: string
Description: Reservation Booking Designator code
Sample Value:
Note:
In the Response
Optional
- Parameter: sabreCode
-
Type: string
Description: Reservation Booking Designator Sabre code
Sample Value:
Note:
In the Response
Optional
- Parameter: name
-
Type: string
Description: Long name of the Reservation booking designator. Example: Premium Economy
Sample Value:
Note:
In the Response
Optional
- Parameter: shortName
-
Type: string
Description: Short name of the Reservation booking designator. Example: PR ECON.
Sample Value:
Note:
In the Response
Optional
- Parameter: lang
-
Type: string
Description: Language of the names
Sample Value:
Note:
In the Response
Optional
- Parameter: BaggageInformationType
-
Type: complexType
Description: Information about baggage
Sample Value:
Note:
In the Response
Optional
- Parameter: Allowance
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: passengerType
-
Type: string
Description: Type of Passenger
Sample Value:
Note:
In the Response
Optional
- Parameter: pieces
-
Type: int
Description: Number of Pieces
Sample Value:
Note:
In the Response
Optional
- Parameter: weight
-
Type: int
Description: Weight Limit
Sample Value:
Note:
In the Response
Optional
- Parameter: unit
-
Type: string
Description: Units of the Weight Limit
Sample Value:
Note:
In the Response
Optional
- Parameter: InsuranceOptOut
-
Type: InsuranceOptOut
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Profile
-
Type: ProfileType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceSummary
-
Type: PriceSummaryType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceProvider
-
Type: PricingProviderType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceSummaryType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: BasePrice
-
Type: DecimalPrice
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: EquivPrice
-
Type: DecimalPrice
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TotalTaxes
-
Type: TaxesType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TotalPrice
-
Type: DecimalPrice
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: id
-
Type: int
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: refreshTimestamp
-
Type: dateTime
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TaxesType
-
Type: complexType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: Tax
-
Type: TaxType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TaxType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TaxAmount
-
Type: DecimalPrice
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TaxCode
-
Type: CommonString
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ProductSource
-
Type: ProductSourceType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ProductSourceType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: code
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: name
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: vendorName
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: supplierName
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: supplierCode
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: FareComponentWithId
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: FareComponent
-
Type: int
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: FareComponentID
-
Type: int
Description: Numeric value identifying fare component
Sample Value:
Note:
In the Response
Optional
- Parameter: ProfileType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ID
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Type
-
Type: string
Description: Type of Profile, it will be having full name like TAGENCY, TAGENCT etc
Sample Value:
Note:
In the Response
Optional
- Parameter: Source
-
Type: string
Description:
Sample Value:
Note:
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
Sample Value:
Note:
In the Response
Optional
- Parameter: PolicyId
-
Type: string
Description: PolicyId of the profile
Sample Value:
Note:
In the Response
Optional
- Parameter: PreferenceId
-
Type: string
Description: PreferenceId of the profile
Sample Value:
Note:
In the Response
Optional
- Parameter: PolicyRemovalReason
-
Type: string
Description: Reason for removing the reason
Sample Value:
Note:
In the Response
Optional
- Parameter: OwningAgency
-
Type: string
Description: Name of the PCC where this profile is stored
Sample Value:
Note:
In the Response
Optional
- Parameter: TierPriority
-
Type: short
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Acquirer
-
Type: string
Description: SabrePWS if Sabre Payment Web Services. User may enter any value for 3rd party acquirer.
Sample Value:
Note:
In the Response
Optional
- Parameter: MaxDurationDays
-
Type: string
Description: Max duration associated with annual multi trip product.
Sample Value:
Note:
In the Response
Optional
- Parameter: PricingProviderType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ProviderName
-
Type: string
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: PricingOptions
-
Type: PricingRequestInformationType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: PricingRequestInformationType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: AirPriceQualifiers
-
Type: AirPriceQualifiersType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: HotelRateQualifiers
-
Type: HotelRateQualifiersType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CarRateQualifiers
-
Type: CarRateQualifiersType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: PromotionEnumtype
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: AirPriceQualifiersType
-
Type: complexType
Description: Specifies passenger numbers and types.
Sample Value:
Note:
In the Response
Optional
- Parameter: SeatsRequested
-
Type: xsd:nonNegativeInteger
Description: The sum of all seats required by all passenger groups.
Sample Value:
Note:
In the Response
Optional
- Parameter: AirTravelerAvail
-
Type: TravelerInformationType
Description: Specifies passenger numbers and types.
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceRequestOptions
-
Type: PriceRequestOptionsType
Description: Identify pricing source, if negotiated fares are requested and if it is a reprice request.
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: GoverningCarrierOverride
-
Type: GoverningCarrierOverrideType
Description: Airline Carrier Code - override the GOVERNING CARRIER to get the fare filed by that carrier.
Sample Value:
Note:
In the Response
Optional
- Parameter: VoluntaryChanges
-
Type: VoluntaryChangesSMPType
Description: Identifies whether penalties associated with voluntary changes should be included in the search results.
Sample Value:
Note:
In the Request
Optional
- Parameter: RetailerRules
-
Type: RetailerRulesType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TaxRules
-
Type: TaxRulesType
Description: Contains tax depending rules.
Sample Value:
Note:
In the Response
Optional
- Parameter: ValidatingCarrier
-
Type: ValidatingCarrierType
Description: Validating carrier rule.
Sample Value:
Note:
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
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: tripType
-
Type: AirTripType
Description: Specify air trip type.
Sample Value:
Note:
In the Response
Optional
- Parameter: xOFares
-
Type: boolean
Description: XOFares indicator
Sample Value:
Note:
In the Request
Optional
- Parameter: CarRateQualifiersType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Corporate
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ID
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CustLoyalty
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: programID
-
Type: string
Description: Identifier to indicate the company owner of the loyalty program.
Sample Value:
Note:
In the Response
Required
- Parameter: membershipId
-
Type: string
Description: Unique identifier of the member in the program (membership number, account number, etc.).
Sample Value:
Note:
In the Response
Optional
- Parameter: GuaranteePrepaid
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: returnGuaranteedRates
-
Type: boolean
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: returnPrepaidRates
-
Type: boolean
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: returnRegularRates
-
Type: boolean
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ID
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Number
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Promotion
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Code
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: type
-
Type: PromotionEnumtype
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: RateCode
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TourCode
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Text
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: VehiclePreferences
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Preference
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: VehicleType
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: LocationPreferences
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: locationCode
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: cityLocation
-
Type: string
Description:
Sample Value:
Note: Possible values are: "E:, "N", "S", "W", "C", "R", "A", "I", "P", "X", "H"
In the Response
Optional
- Parameter: VendorPreferences
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: VendorPreference
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: code
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: exclude
-
Type: boolean
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: SpecialEquipmentPreferences
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Preference
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: equipType
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ccRate
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: commission
-
Type: boolean
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: currencyCode
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: mileagePlan
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: rateAssured
-
Type: boolean
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: rateCategory
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ratePlan
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: HotelRateQualifiersType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: RateAccessCode
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: code
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ContractNegotiatedRateCode
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: RatePlanCode
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ValidatingCarrierType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Preference
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: code
-
Type: CarrierCode
Description: Validating Carrier code
Sample Value:
Note:
In the Response
Required
- Parameter: level
-
Type: ValidatingCarrierPreferLevelType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TaxRulesType
-
Type: complexType
Description: Combines exemption rules connected with taxes.
Sample Value:
Note:
In the Request
Optional
- Parameter: ExemptAllTaxes
-
Type: boolean
Description: Exempt all taxes (/TE)
Sample Value:
Note:
In the Response
Optional
- Parameter: ExemptTax
-
Type: TaxCodeType
Description: Exempt Tax (/TE)
Sample Value:
Note:
In the Response
Optional
- Parameter: RetailerRulesType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: RetailerRule
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: code
-
Type: string
Description: pattern value=[0-9a-zA-Z]{2,20}
Sample Value:
Note:
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
Sample Value:
Note:
In the Response
Optional
- Parameter: VoluntaryChangesSMPType
-
Type: complexType
Description: Specifies charges and/or penalties associated with making ticket changes after purchase.
Sample Value:
Note:
In the Response
Optional
- Parameter: Penalty
-
Type: complexType
Description: Specifies penalty charges as either a currency amount or a percentage of the fare.
Sample Value:
Note:
In the Response
Optional
- 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"
In the Response
Optional
- Parameter: exclude
-
Type: boolean
Description: Indicate that specific penalty type should be excluded from the response.
Sample Value:
Note:
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.
Sample Value:
Note: Possible values are: "After" and "Before"
In the Response
Optional
- 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
In the Response
Optional
- Parameter: GoverningCarrierOverrideType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: airlineCode
-
Type: CarrierCode
Description: Airline Carrier Code - override the GOVERNING CARRIER to get the fare filed by that carrier.
Sample Value:
Note:
In the Request
Optional
- Parameter: TravelerRatingType
-
Type: complexType
Description: Customer Value Scores and Frequent Flyer Tiers for one traveler. It can influence Availability results when provided.
Sample Value:
Note:
In the Response
Optional
- Parameter: Score
-
Type: ScoreType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: FrequentFlyer
-
Type: FrequentFlyerType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ScoreType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: value
-
Type: integer
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: carrier
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: FrequentFlyerType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: tier
-
Type: integer
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: NegotiatedFareCodeType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Supplier
-
Type: string
Description: This element indicates the supplier associated with a negotiated fare code.
Sample Value:
Note:
In the Response
Optional
- Parameter: AccountCodeType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: IndDefaultFalseType
-
Type: complexType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: ind
-
Type: boolean
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: IndType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: IndRequiredType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: ind
-
Type: boolean
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: PriorityType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: priority
-
Type: int
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: PriorityLegType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: leg
-
Type: positiveInteger
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CarrierType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: Carrier
-
Type: complexType
Description: Specifies desired order of carriers
Sample Value:
Note:
In the Response
Optional
- Parameter: PriorityComplexType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Price
-
Type: PriorityType
Description: Prefer cheaper itineraries
Sample Value:
Note:
In the Response
Optional
- Parameter: DirectFlights
-
Type: PriorityLegType
Description: Prefer itineraries will less connections
Sample Value:
Note:
In the Response
Optional
- Parameter: Time
-
Type: PriorityType
Description: Prefer itineraries departing closer to requested departure time
Sample Value:
Note:
In the Response
Optional
- Parameter: Vendor
-
Type: PriorityType
Description: Promote certain marketing carriers over all the others in returning results. (configured in rules).
Sample Value:
Note:
In the Response
Optional
- Parameter: MarketingCarrier
-
Type: CarrierType
Description: Prefer itineraries with marketing carriers in order speciied in Carrier subtags, comparing segment-wise
Sample Value:
Note:
In the Response
Optional
- Parameter: OperatingCarrier
-
Type: CarrierType
Description: Prefer itineraries with operating carriers in order speciied in Carrier subtags, comparing segment-wise
Sample Value:
Note:
In the Request
Optional
- Parameter: ElapsedTime
-
Type: PriorityType
Description: Prefer itineraries with shorter travel times
Sample Value:
Note:
In the Response
Optional
- Parameter: DepartureTime
-
Type: PriorityLegType
Description: Prefer itineraries departing earlier during the day
Sample Value:
Note:
In the Response
Optional
- Parameter: ConnectionTime
-
Type: PriorityLegType
Description: Prefer itineraries with smaller amount of time waiting in the airports during connections
Sample Value:
Note:
In the Response
Optional
- Parameter: IndicatorsType
-
Type: complexType
Description:
Sample Value:
Note:
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.
Sample Value:
Note:
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.
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: TravelPolicy
-
Type: IndRequiredType
Description: This element is currently ignored whether it is true or false.
Sample Value:
Note:
In the Response
Optional
- 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.
In the Response
Optional
- Parameter: ItinerariesPerGroupType
-
Type: complexType
Description:
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: BrandedFareIndicatorsType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ReturnCheapestUnbrandedFare
-
Type: IndRequiredType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: singleBrandedFare
-
Type: boolean
Description: Return single brand option per itin
Sample Value:
Note:
In the Response
Optional
- Parameter: multipleBrandedFares
-
Type: boolean
Description: Return multiple brand options per itin
Sample Value:
Note:
In the Response
Optional
- Parameter: returnBrandAncillaries
-
Type: boolean
Description: Return ancillaries from the ATPCO Branded Fares Feature
Sample Value:
Note:
In the Response
Optional
- Parameter: PassengerStatusEnumType
-
Type: string
Description: Possible values are: "R" - Residency; "E" - Employment; "N" Nationality
Sample Value:
Note:
In the Response
Optional
- Parameter: PassengerStatusType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: StateCode
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CountryCode
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CityCode
-
Type: AlphaLength3
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: type
-
Type: PassengerStatusEnumType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ETicketableOverrideType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CurrencyType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: dual
-
Type: AlphaLength3
Description: Dual currency
Sample Value:
Note:
In the Response
Optional
- Parameter: mOverride
-
Type: boolean
Description: M override
Sample Value:
Note:
In the Response
Optional
- Parameter: OBFeesType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: rType
-
Type: boolean
Description: Indicator Returning R-Type OB Fees
Sample Value:
Note:
In the Response
Optional
- Parameter: tType
-
Type: boolean
Description: Indicator Returning T-Type OB Fees
Sample Value:
Note:
In the Response
Optional
- Parameter: FareAdjustmentType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: value
-
Type: string
Description: Adjustment Value, can be positive or negative, number or percentage
Sample Value:
Note:
In the Response
Optional
- Parameter: currency
-
Type: AlphaLength3
Description: Currency of Adjustment's Value
Sample Value:
Note:
In the Response
Optional
- Parameter: ValueType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: value
-
Type: decimal
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceRequestOptionsType
-
Type: complexType
Description: Identify pricing source, if negotiated fares are requested and if it is a reprice request.
Sample Value:
Note:
In the Response
Optional
- Parameter: NegotiatedFareCode
-
Type: NegotiatedFareCodeType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: AccountCode
-
Type: AccountCodeType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: PublicFare
-
Type: IndDefaultFalseType
Description: This element finds only public fares.
Sample Value:
Note:
In the Response
Optional
- Parameter: PrivateFare
-
Type: IndDefaultFalseType
Description: This element finds only private fares.
Sample Value:
Note:
In the Response
Optional
- Parameter: IATAFare
-
Type: IndDefaultFalseType
Description: This element finds only IATA fares.
Sample Value:
Note:
In the Response
Optional
- Parameter: WebFare
-
Type: IndType
Description: Web fare
Sample Value:
Note:
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.
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: PromoID
-
Type: string
Description: Promotional Identifier - a string which identifies a promotion, possibly giving a discount prices etc.
Sample Value:
Note:
In the Response
Optional
- Parameter: CustomerType
-
Type: CustomerComplexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: MultipleTravelerGroups
-
Type: ItinerariesPerGroupType
Description: This element governs how flights are returned when multiple passenger groups are requested.
Sample Value:
Note:
In the Response
Optional
- Parameter: BrandedFareIndicators
-
Type: BrandedFareIndicatorsType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: PassengerStatus
-
Type: PassengerStatusType
Description:
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: PointOfTicketingOverride
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: ApplyResidentDiscount
-
Type: boolean
Description: Apply resident discount in CLFE
Sample Value:
Note:
In the Response
Optional
- Parameter: ETicketableOverride
-
Type: ETicketableOverrideType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Currency
-
Type: CurrencyType
Description:
Sample Value:
Note:
In the Request
Optional
- Parameter: UseReducedConstructions
-
Type: IndType
Description: Use reduced constructions (simple fare paths with restrictions on the number of fare components).
Sample Value:
Note:
In the Response
Optional
- Parameter: OBFees
-
Type: OBFeesType
Description:
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: FareAdjustment
-
Type: FareAdjustmentType
Description: Capability to specify Plus-Up and Discount Amount and Percentage.
Sample Value:
Note:
In the Request
Optional
- Parameter: ForceCompanion
-
Type: ValueType
Description: Force companion fare value.
Sample Value:
Note:
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.
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: UseNegotiatedFares
-
Type: IndRequiredType
Description: Returned fares need to match AcccountCode/CorporateID on at least one fare component.
Sample Value:
Note:
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
Sample Value:
Note:
In the Request
Optional
- Parameter: currencyCode
-
Type: AlphaLength3
Description: Type of funds preferred for reviewing monetary values, in ISO 4217 codes.
Sample Value:
Note:
In the Request
Optional
- Parameter: pricingSource
-
Type: RequestPricingSourceType
Description: It can be used to indicate whether the fare is public or private.
Sample Value:
Note:
In the Response
Optional
- Parameter: reprice
-
Type: boolean
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: processThruFaresOnly
-
Type: boolean
Description: Activates processing of thru fares only.
Sample Value:
Note:
In the Response
Optional
- Parameter: purchaseDate
-
Type: date
Description: Specify purchase date. Fares returned will be based on the purchase date.
Sample Value:
Note:
In the Response
Optional
- Parameter: purchaseTime
-
Type: string
Description: Specify purchase time. Fares returned will be based on the purchase time.
Sample Value:
Note:
In the Response
Optional
- Parameter: netFaresUsed
-
Type: boolean
Description: Set to true when exchange ticket uses net fare.
Sample Value:
Note:
In the Response
Optional
- 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"
In the Response
Optional
- Parameter: secondaryCode
-
Type: string
Description: An additional attribute to allow flexibility for particular organizations who require an additional code.
Sample Value:
Note:
In the Response
Optional
- Parameter: supplierCode
-
Type: string
Description: An additional attribute to allow flexibility for particular organizations who require an additional supplier code.
Sample Value:
Note:
In the Response
Optional
- Parameter: codeContext
-
Type: string
Description: Identifies the source authority for the code.
Sample Value:
Note:
In the Response
Optional
- Parameter: URI
-
Type: anyURI
Description: Identifies the location of the code table
Sample Value:
Note:
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)
Sample Value:
Note:
In the Response
Optional
- Parameter: TravelerInformationType
-
Type: complexType
Description: Specifies passenger numbers and types.
Sample Value:
Note:
In the Response
Optional
- Parameter: PassengerTypeQuantity
-
Type: PassengerTypeQuantityType
Description: Specifies number of passengers using Passenger Type Codes.
Sample Value:
Note:
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.
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: CustLoyalty
-
Type: CustLoyaltyType
Description: Specify a customer loyalty program.
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: FlightSegmentRPHs
-
Type: FlightSegmentRPHsType
Description: Reference pointers to flight segments
Sample Value:
Note:
In the Response
Required
- Parameter: passengerTypeCode
-
Type: AlphaLength3
Description: A three-letter code representing passenger type (e.g. .ADT. for adult, .CNN. for child)
Sample Value:
Note:
In the Response
Optional
- Parameter: accompaniedByInfant
-
Type: boolean
Description: Indicates if an infant accompanying a traveler is with or without a seat.
Sample Value:
Note:
In the Response
Optional
- Parameter: FlightSegmentRPHsType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: FlightSegmentRPH
-
Type: string
Description: Reference to the flight segments for this traveler
Sample Value:
Note:
In the Response
Optional
- Parameter: TravelerRefNumberType
-
Type: complexType
Description: A reference place holder used as a pointer to link back to the traveler.
Sample Value:
Note:
In the Response
Optional
- Parameter: RPH
-
Type: string
Description: Reference place holder.
Sample Value:
Note:
In the Response
Optional
- Parameter: CustLoyaltyType
-
Type: complexType
Description: Program rewarding frequent use by accumulating credits for services provided by vendors.
Sample Value:
Note:
In the Response
Optional
- Parameter: travelSector
-
Type: string
Description: Identifies the travel sector. Refer to OTA Code List Travel Sector (TVS).
Sample Value:
Note:
In the Response
Optional
- Parameter: loyalLevel
-
Type: string
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: singleVendorInd
-
Type: SingleVendorIndType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: signupDate
-
Type: date
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: SingleVendorIndType
-
Type: NMTOKEN
Description: Indicates if program is affiliated with a group of related offers accumulating credits.
Sample Value:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: BirthDate
-
Type: BirthDateType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Age
-
Type: AgeType
Description: Exchange-specific
Sample Value:
Note:
In the Response
Optional
- Parameter: State
-
Type: StateType
Description: Exchange-specific
Sample Value:
Note:
In the Response
Optional
- Parameter: TotalNumber
-
Type: TotalNumberType
Description: Exchange-specific
Sample Value:
Note:
In the Response
Optional
- Parameter: changeable
-
Type: boolean
Description: Default value is "true"
Sample Value:
Note:
In the Response
Optional
- Parameter: index
-
Type: int
Description: Allows to identify which one of requested passengers this solution relates to.
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: BirthDateType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: date
-
Type: date
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: AgeType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: years
-
Type: short
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: StateType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: TotalNumberType
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Required
- Parameter: value
-
Type: short
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: AlphaLength3
-
Type: string
Description: Used for Alphabetic Strings, length exactly 3
Sample Value:
Note: pattern value="[a-zA-Z]{3}"
In the Response
Optional
- Parameter:
-
Type:
Description:
Sample Value:
Note:
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 bothTrading Partners).
Sample Value:
Note:
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.
Sample Value:
Note:
In the Response
Optional
- Parameter: currencyCode
-
Type: CurrencyCodeType
Description: A currency code (e.g. USD, EUR, PLN)
Sample Value:
Note:
In the Response
Optional
- Parameter: TaxCodeType
-
Type: complexType
Description: Defines the data fields available for tax code.
Sample Value:
Note:
In the Response
Required
- Parameter: taxCode
-
Type: string
Description: Identifies the code for the tax.
Sample Value:
Note:
In the Response
Optional
- Parameter: CabinPrefType
-
Type: complexType
Description: Indicates preferences for choice of airline cabin for a given travel situation.
Sample Value:
Note:
In the Response
Optional
- Parameter: preferLevel
-
Type: PreferLevelType
Description: Used to indicate a level of preference for an associate item, only, unacceptable, preferred.
Sample Value:
Note: Default value is "Preferred"
In the Response
Optional
- Parameter:
-
Type:
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: cabin
-
Type: CabinNameType
Description: Specify cabin type.
Sample Value:
Note:
In the Response
Optional
- Parameter: CabinNameType
-
Type: NMTOKEN
Description: A 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: Premium First, P, First, F, Premium Business, J, Business, C, Premium Economy, S, Economy, Y
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.).
Sample Value:
Note: Possible values are: "Only", "Unacceptable", "Preferred"
In the Response
Optional
- Parameter: Money
-
Type: decimal
Description: Used for amounts, max 3 decimals
Sample Value:
Note:
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".
Sample Value:
Note:
In the Response
Optional
- Parameter: amount
-
Type: Money
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CurrencyCodeType
-
Type: AlphaLength3
Description: Used for Currency Codes
Sample Value:
Note:
In the Response
Optional
- Parameter: CarrierCode
-
Type: string
Description:
Sample Value:
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.
Sample Value:
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.
Sample Value:
Note: Possible values are: "Unacceptable" and "Preferred"
In the Response
Optional
- Parameter: RefundResult
-
Type: RefundResult.PNRB
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: BookAndHoldResult
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: AirlineCode
-
Type: AirlineCode
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: Status
-
Type: complexType
Description: Result of holding a booking for a given airline; SUCCESS, FAILURE
Sample Value:
Note:
In the Response
Optional
- Parameter: message
-
Type: string
Description: Additional information of the holding result
Sample Value:
Note:
In the Response
Optional
- Parameter: OwningAgency
-
Type: AgencyName
Description: This attribute specifies the PCC, where the profile exist. It can be alphanumeric value of 4 length.
Sample Value:
Note:
In the Response
Optional
- Parameter: AgencyName
-
Type: string
Description: pattern value = "[A-Z0-9]{4}"
Sample Value:
Note:
In the Response
Optional
- Parameter: CarrierRefundItem.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Response
Optional
- Parameter: CarrierRecordLocator
-
Type: string
Description: Determines which segment will be refunded
Sample Value:
Note:
In the Request
Optional
- Parameter: SegmentSubset
-
Type: SegmentSubset
Description: Tries to refund all possible segments.
Sample Value:
Note:
In the Request
Optional
- Parameter: PaymentAuthorizationCode
-
Type: string
Description: Code needed to handle payment processing
Sample Value:
Note:
In the Request
Optional
- Parameter: SegmentSubset
-
Type: string
Description: Tries to refund all possible values
Sample Value:
Note:
In the Request
Optional
- Parameter: RefundResult.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CarrierResult.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CarrierResult
-
Type: CarrierResult.PNRB
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: WarningCarrierResult
-
Type: WarningCarrierResult.PNRB
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CarrierResult.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: CarrierCode
-
Type: string
Description: Determines segment carrier that will be refund.
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Currency
-
Type: string
Description: Currency amount that will be refund.
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: WarningCarrierRefund.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: Message
-
Type: Determines the cause, why segments for carrier can not be refund.
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: BookAndHoldType.PNRB
-
Type: complexType
Description:
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AirlineCode
-
Type: AirlineCode
Description: Determines airline whose segments should be held. If not provided, all eligible segments will be held.
Sample Value:
Note:
Relase note ID: 12996
v1.16.0 | May 12, 2017
- PQ Fare Component data
- Disclosure Carrier support
- Change of Gauge indicator
- Hidden Stop, Elapsed Time and Air Miles Flown for flight
- Ability to update/cancel Email Address in PNR using UpdateReservationRQ
API Information
What's New
- PQ Fare Component data
- Disclosure Carrier support
- Change of Gauge indicator
- Hidden Stop, Elapsed Time and Air Miles Flown for flight
- Ability to update/cancel Email Address in PNR using UpdateReservationRQ
New Features
In the Response
Optional
- Parameter: Language
-
Type: boolean
Description: "Language" is used to translate attributes (like Cabin name)
Sample Value:
Note:
In the Response
Optional
- Parameter: id
-
Type: UniqueIdentifier
Description: Unique id
Sample Value:
Note:
In the Response
Optional
- Parameter: op
-
Type: OperationType
Description: Operation Type (C = Create, U = Update, D = Delete)
Sample Value:
Note:
In the Response
Optional
- Parameter: isDirectConnectPlatformBooking
-
Type: boolean
Description: Indicates if Direct Connect Platform (DCP) booking, created by GSA or ownership changed to DCP by RES agent
Sample Value:
Note:
In the Response
Optional
- Parameter: isDirectConnectPlatformBooking
-
Type: boolean
Description: Indicates if Direct Connect Platform (DCP) booking, created by GSA or ownership changed to DCP by RES agent
Sample Value:
Note:
In the Request/Response
Optional
- Parameter: AirSegmentUpdate
-
Type: complex
Description: Used to book/delete air segment
Sample Value:
Note: This element has been deleted
In the Response
Optional
- Parameter: FareComponent
-
Type: complex
Description: Fare Component is used to return Fare Component Data
Sample Value:
Note:
In the Response
Optional
- Parameter: Location
-
Type: complex
Description: Location is used to return Origin and Destination for Fare component
Sample Value:
Note:
In the Response
Optional
- Parameter: Origin
-
Type: string
Description: Origin is used to return origin of Fare Component
Sample Value:
Note:
In the Response
Optional
- Parameter: Destination
-
Type: string
Description: Destination is used to return Destination of Fare Component
Sample Value:
Note:
In the Response
Optional
- Parameter: Dates
-
Type: complex
Description: Dates are used to return departure and arrival date and time of Fare Component
Sample Value:
Note:
In the Response
Optional
- Parameter: DepartureDateTime
-
Type: srting
Description: Departure Date Time is used to return departure date and time of Fare Component
Sample Value:
Note:
In the Request
Optional
- Parameter: ArrivalDateTime
-
Type: string
Description: Arrival Date Time is used to return arrival date and time of Fare Component
Sample Value:
Note:
In the Response
Optional
- Parameter: FlightSegmentNumbers
-
Type: complex
Description: Fare Segment Numbers are used to return flights associated with Fare Component
Sample Value:
Note:
In the Response
Optional
- Parameter: FlightSegmentNumber
-
Type: string
Description: FareSegmentNumber is used to return single flight associated with Fare Component
Sample Value:
Note:
In the Response
Optional
- Parameter: FareBasisCode
-
Type: string
Description: Fare Basis Code is used to return Fare Basis Code of Fare Component
Sample Value:
Note:
In the Request
Optional
- Parameter: FareDirectionality
-
Type: string
Description: Fare Directionality is used to return Directionality of Fare used for particular Fare Component (TO; FROM)
Sample Value:
Note:
In the Response
Optional
- Parameter: Amount
-
Type: string
Description: Amount is used to return NUC amount for particular Fare Component
Sample Value:
Note:
In the Request
Optional
- Parameter: TicketDesignator
-
Type: string
Description: TicketDesignator is used to return Ticket Designator Code attached to Fare Basis Code.
Sample Value:
Note:
In the Response
Optional
- Parameter: GoverningCarrier
-
Type: string
Description: used to return Governing Carrier Code (e.g. EY, AA, LH)
Sample Value:
Note:
In the Response
Optional
- Parameter: FareComponentNumber
-
Type: string
Description: used to display number of fare component stored in PQ
Sample Value:
Note:
In the Response
Optional
- Parameter: RuleName
-
Type: string
Description: used to return rule details
Sample Value:
Note:
In the Response
Optional
- Parameter: Deal
-
Type: complex
Description: used to return information about applied discount/markup for this ancillary
Sample Value:
Note:
In the Response
Optional
- Parameter: Percentage
-
Type: decimal
Description: used to return information defined in RULE for percentage discounts/markups
Sample Value:
Note:
In the Response
Optional
- Parameter: Amount
-
Type: decimal
Description: used to return information defined in RULE for monetary discounts/markups
Sample Value:
Note:
In the Response
Optional
- Parameter: Currency
-
Type: string
Description: used to return information defined in RULE for monetary discounts/markups
Sample Value:
Note:
In the Response
Required
- Parameter: Type
-
Type: string
Description: used to return information about deal type
Sample Value:
Note:
In the Response
Optional
- Parameter: RuleId
-
Type: string
Description: used to return Rule Id
Sample Value:
Note:
In the Response
Optional
- Parameter: DisclosureCarrier
-
Type: complex
Description: used to return operated flight data
Sample Value:
Note:
In the Response
Optional
- Parameter: Banner
-
Type: string
Description: used to return the disclosure carrier message
Sample Value:
Note:
In the Response
Optional
- Parameter: Code
-
Type: string
Description: used to return the disclosure carrier code associated with the particular flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: DOT
-
Type: boolean
Description: DOT is optional data from DSS it determines Banner appearance
Sample Value:
Note:
In the Response
Optional
- Parameter: ElapsedTime
-
Type: string
Description: used to return the elapsed time associated with the particular flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: AirMilesFlown
-
Type: string
Description: used to return the air miles flown associated with the particular flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: HiddenStop
-
Type: complex
Description: used to return Hidden stop details (Airport, Date of arrival/departure)
Sample Value:
Note:
In the Response
Optional
- Parameter: ArrivalDateTime
-
Type: string
Description: used to return arrival date and time from Hidden Stop
Sample Value:
Note:
In the Response
Optional
- Parameter: DepartureDateTime
-
Type: string
Description: used to return departure date and time from Hidden Stop
Sample Value:
Note:
In the Response
Optional
- Parameter: Airport
-
Type: string
Description: used to determine airport location code
Sample Value:
Note:
In the Response
Optional
- Parameter: FunnelFlight
-
Type: boolean
Description: used to determine if a flight is a funnel flight type
Sample Value:
Note:
In the Response
Optional
- Parameter: ChangeOfGauge
-
Type: boolean
Description: used to determine a funnel flight type for flight segment
Sample Value:
Note:
In the Response
Optional
- Parameter: InstantPurchase
-
Type: boolean
Description: Indication of LCC segment. (e.g. FALSE)
Sample Value:
Note:
In the Response
Optional
- Parameter: BrandID
-
Type: BrandIDType
Description: 2 Chars string representing sold brand. (e.g. PE)
Sample Value:
Note:
In the Response
Optional
- Parameter: Cabin
-
Type: complex
Description: is used to return cabin code
Sample Value:
Note:
In the Response
Optional
- Parameter: Code
-
Type: string
Description: is used to return Reservation Booking Designator code for cabin
Sample Value:
Note:
In the Response
Optional
- Parameter: SabreCode
-
Type:
Description: is used to return Reservation Booking Designator sabre code for cabin
Sample Value:
Note:
In the Response
Optional
- Parameter: Name
-
Type: string
Description: is used to return long name of the Reservation booking designator (i.e Premium Economy)
Sample Value:
Note:
In the Request
Optional
- Parameter: ShortName
-
Type: string
Description: is used to return short name of the Reservation booking designator (i.e PR ECON)
Sample Value:
Note:
In the Response
Optional
- Parameter: Lang
-
Type: string
Description: is used to return Language of the names for Cabin
Sample Value:
Note:
In the Response
Optional
- Parameter: Loyalty
-
Type: Loyalty
Description: is used to return loyalty data
Sample Value:
Note:
In the Response
Optional
- Parameter: FrequentFlayer
-
Type: FrequentFlayer
Description: is used to return FF data
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceCache
-
Type: PriceCache
Description: is used to return Pricing data
Sample Value:
Note:
In the Response
Optional
- Parameter: TripProposalReference
-
Type: TripProposalReference
Description: is used to link Trip Proposal to PNR
Sample Value:
Note:
In the Response
Optional
- Parameter: Loyalty
-
Type: string
Description: is used to return loyalty data
Sample Value:
Note:
In the Response
Optional
- Parameter: ServiceRequest
-
Type: string
Description: is used to return request data
Sample Value:
Note:
In the Response
Optional
- Parameter: Email
-
Type: string
Description: is used to return Email data
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceCache
-
Type: string
Description: is used to return Pricing data
Sample Value:
Note:
In the Response
Optional
- Parameter: InsuranceOptOut
-
Type: string
Description: is used to return insurance data
Sample Value:
Note:
In the Response
Optional
- Parameter: TripProposalReference
-
Type: string
Description: is used to return Trip Proposal data
Sample Value:
Note:
In the Response
Optional
- Parameter: Visa
-
Type: VisaType
Description: is used to return Visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: Insurance
-
Type: InsuranceType
Description: is used to return insurance data
Sample Value:
Note:
In the Response
Optional
- Parameter: Vehicle
-
Type: VehicleType
Description: is used to return car data
Sample Value:
Note:
In the Response
Optional
- Parameter: Other
-
Type: OtherType
Description: is used to return other data
Sample Value:
Note:
In the Response
Optional
- Parameter: Ski
-
Type: SkiType
Description: is used to return ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: comment
-
Type: string
Description: is used to return comments
Sample Value:
Note:
In the Response
Optional
- Parameter: VisaType
-
Type: ComplexType
Description: is used to return Visa type data
Sample Value:
Note:
In the Response
Optional
- Parameter: CustomerResponsibility ID
-
Type: string
Description: is used to return id data
Sample Value:
Note:
In the Response
Optional
- Parameter: Rates
-
Type: complexType
Description: is used to return rate data
Sample Value:
Note:
In the Response
Optional
- Parameter: FOP
-
Type: string
Description: is used to return form of payment data
Sample Value:
Note:
In the Response
Optional
- Parameter: amount
-
Type: decimal
Description: is used to return rates amount
Sample Value:
Note:
In the Response
Optional
- Parameter: currency
-
Type: string
Description: is used to return currency code for rates amount
Sample Value:
Note:
In the Response
Optional
- Parameter: ServiceFee
-
Type: complexType
Description: is used to return fee data
Sample Value:
Note:
In the Response
Optional
- Parameter: amount
-
Type: decimal
Description: is used to return service fee amount
Sample Value:
Note:
In the Response
Optional
- Parameter: currency
-
Type: string
Description: is used to return service fee currency
Sample Value:
Note:
In the Response
Optional
- Parameter: DestinationCountry
-
Type: complexType
Description: is used to return destination data
Sample Value:
Note:
In the Response
Optional
- Parameter: code
-
Type: string
Description: is used to return destination country code
Sample Value:
Note:
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return Destination Country name
Sample Value:
Note:
In the Response
Optional
- Parameter: ProcessingTime
-
Type: complexType
Description: is used to return processing time data
Sample Value:
Note:
In the Response
Optional
- Parameter: Duration
-
Type: string
Description: is used to return duration of processing time
Sample Value:
Note:
In the Response
Optional
- Parameter: used to return duration of processing time
-
Type: string
Description: is used to return notes
Sample Value:
Note:
In the Response
Optional
- Parameter: Unit
-
Type: string
Description: is used to return processing time unit data
Sample Value:
Note:
In the Response
Optional
- Parameter: Purpose
-
Type: complexType
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: Comments
-
Type: string
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: Transit
-
Type: complexType
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: City
-
Type: complexType
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: Vendor
-
Type: complexType
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: Name
-
Type: string
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: Duration
-
Type: string
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: Payment
-
Type: string
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: Receiver
-
Type: string
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: PricingElements
-
Type: PricingElementsType
Description: is used to return additional visa data
Sample Value:
Note:
In the Response
Optional
- Parameter: Ski
-
Type: complexType
Description: is used to return ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Booking
-
Type: complexType
Description: is used to return ski data
Sample Value:
Note:
In the Request
Optional
- Parameter: ID
-
Type: string
Description: is used to return Id of the ski booking data
Sample Value:
Note:
In the Response
Optional
- Parameter: ChangePolicy
-
Type: complexType
Description: is used to return ski change policy data
Sample Value:
Note:
In the Response
Optional
- Parameter: Conditions
-
Type: string
Description: is used to return ski change policy conditions data
Sample Value:
Note:
In the Response
Optional
- Parameter: ConditionsDefault
-
Type: string
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: City
-
Type: complexType
Description: is used to return additional ski data
Sample Value:
Note:
In the Request
Optional
- Parameter: code
-
Type: string
Description: is used to return additional ski data
Sample Value:
Note:
In the Request
Optional
- Parameter: name
-
Type: string
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: ClothingHire
-
Type: complexType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Item
-
Type: is used to return additional ski data
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: EquipmentHire
-
Type: SkiCommonElementsType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Extras
-
Type: SkiCommonElementsType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Lessons
-
Type: SkiCommonElementsType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: LiftPass
-
Type: SkiCommonElementsType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Location
-
Type: complexType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Regions
-
Type: complexType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Resort
-
Type: complexType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Vendor
-
Type: complexType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: code
-
Type: string
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Transfers
-
Type: complexType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: Description
-
Type: string
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: PricingElements
-
Type: PricingElementsType
Description: is used to return additional ski data
Sample Value:
Note:
In the Response
Optional
- Parameter: LateDeparturePolicy
-
Type: string
Description: is used to return additional Hotel product data
Sample Value:
Note:
In the Response
Optional
- Parameter: PricingElements
-
Type: PricingElementsType
Description: is used to return additional Hotel product data
Sample Value:
Note:
In the Response
Optional
- Parameter: LateDepartureRequired
-
Type: boolean
Description: is used to return additional Hotel product data
Sample Value:
Note:
In the Response
Optional
- Parameter: SeatNumber
-
Type: string
Description: is used to return additional rail product data
Sample Value:
Note:
In the Response
Optional
- Parameter: TypeOfPass
-
Type: string
Description: is used to return additional rail product data
Sample Value:
Note:
In the Response
Optional
- Parameter: DateOfBirth
-
Type: date
Description: is used to return additional data for ground transportation product
Sample Value:
Note:
In the Response
Optional
- Parameter: Profile
-
Type: complexType
Description: is used to return additional ground transportation product data
Sample Value:
Note:
In the Response
Optional
- Parameter: ID
-
Type: string
Description: is used to return additional ground transportation product data
Sample Value:
Note:
In the Response
Optional
- Parameter: Type
-
Type: string
Description: is used to return additional ground transportation product data
Sample Value:
Note:
In the Response
Optional
- Parameter: source
-
Type: string
Description: is used to return additional ground transportation product data
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceCache
-
Type: complexType
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: ProviderName
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Comment
-
Type: complexType
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: type
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: ProviderRequest
-
Type: complexType
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: ProviderResponse
-
Type: complexType
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Loyalty
-
Type: complexType
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: ProgramName
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: MembershipID
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: LoyaltyLevel
-
Type: CodeDescription
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Code
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: EffectiveDate
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: ExpireDate
-
Type: dateTime
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Remark
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Metadata
-
Type: complexType
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: DisplayIndex
-
Type: int
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: FrequentFlyer
-
Type: complexType
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: PartnershipAirlineCodes
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: ActionCode
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: PreviousActionCode
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Vendor
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Request
Optional
- Parameter: ReceivingCarrierCode
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Request
Optional
- Parameter: VitType
-
Type: short
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: FrequentFlyerNumber
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: MembershipID
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: ProductType
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: ProgramCode
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Provider
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: CITierLevel
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: ATPCOTierLevel
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Indicators
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Text
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Banner
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Tag
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: Tag2Char
-
Type: string
Description: is used to return open reservation element data
Sample Value:
Note:
In the Response
Optional
- Parameter: PriceQuoteType
-
Type: complexType
Description: is used to return PQ open reservation element data
Sample Value:
Note:
In the Request
Optional
- Parameter: AirSegmentUpdate
-
Type: AirSegmentUpdate
Description: This Element has been DELETED
Sample Value:
Note:
Relase note ID: 13035