API Information

Response Format
XML
Service Action Code
GetReservationRQ
Current Version
1.17.0
Target Audience
Both TN and AS
Environment
Production
Documentation
Go to the Get Reservation documentation

What's New

  • Book and Hold XML response
  • Extend insurance product for annual multi trip
  • Implementation of full GetReservationRQ flow with
  • Additional logic for populating passenger type was added

New Features

In the Request

Optional

Parameter: AirMilesFlown

Type: int

Description: Air miles flown associated with the particular flight segment

Sample Value:

Parameter: Tax

Type: TaxType

Description:

Sample Value:

In the Response

Optional

Parameter: Language

Type: string

Description: "Language" is used to translate attributes (like Cabin name)

Sample Value:

EN
Parameter: RefundResult

Type: RefundResult.PNRB

Description: RefundResult is used to display results of refund action

Sample Value:

Parameter: BookAndHoldResult

Type: complexType

Description: BookAndHoldResult is used to return results of book and hold functionality

Sample Value:

Parameter: AirlineCode

Type: AirlineCode

Description: AirlineCode is used to return carrier code

Sample Value:

AA
Parameter: Status

Type: complexType

Description: Status is used to return status of book and hold functionality

Sample Value:

SUCCESS
Parameter: OwningAgency

Type: AgencyName

Description: This attribute specifies the PCC, where the profile exist. It can be of alphanumeric value of 4 length

Sample Value:

W0H3
Parameter: AgencyName

Type: string

Description:

Sample Value:

Parameter: CarrierRefundItem

Type: complexType

Description:

Sample Value:

Parameter: CarrierRecordLocator

Type: string

Description: Determines which segments will be refunded

Sample Value:

Parameter: SegmentSubset

Type: SegmentSubset

Description: Tries to refund all possible segments

Sample Value:

Parameter: PaymentAuthorizationCode

Type:

Description: Code needed to handle payment processing

Sample Value:

Parameter: SegmentSubset

Type: simpleType

Description: Tries to refund all possible segments

Sample Value:

Parameter: RefundResult

Type: complexType

Description:

Sample Value:

Parameter: CarrierRefund

Type: CarrierRefund.PNRB

Description:

Sample Value:

Parameter: WarningCarrierRefund

Type: WarningCarrierRefund.PNRB

Description:

Sample Value:

Parameter: CarrierRefund

Type: complexType

Description:

Sample Value:

Parameter: Amount

Type: string

Description: Determines amount that will be refund

Sample Value:

Parameter: CarrierCode

Type: string

Description: Determines segment carrier that will be refund

Sample Value:

Parameter: Currency

Type: string

Description: Currency amount that will be refund

Sample Value:

Parameter: WarningCarrierRefund

Type: complexType

Description:

Sample Value:

Parameter: CarrierCode

Type: string

Description: Determines segment carrier that will not be refund

Sample Value:

Parameter: Message

Type: string

Description: Determines the cause, why segments for carrier can not be refund

Sample Value:

Parameter: BookAndHoldType

Type: complexType

Description:

Sample Value:

Parameter: AirlineCode

Type: AirlineCode

Description: Determines airline whose segments should be held. If not provided, all eligible segments will be held

Sample Value:

Parameter: Cabin

Type: CabinType

Description: Generic cabin description data

Sample Value:

Parameter: MealCode

Type: string

Description: Meal code associated with the particular flight segment

Sample Value:

Parameter: SmokingAllowed

Type: boolean

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

Sample Value:

Parameter: StopQuantity

Type: int

Description: Number of stops associated with the particular flight segment

Sample Value:

Parameter: ElapsedTime

Type: int

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

Sample Value:

Parameter: HiddenStop

Type: complexType

Description: Used to return hidden stop details

Sample Value:

Parameter: ArrivalDateTime

Type: string

Description: Arrival date and time to hidden stop

Sample Value:

Parameter: DepartureDateTime

Type: string

Description: Departure date and time from hidden stop

Sample Value:

Parameter: Airport

Type: string

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

Sample Value:

Parameter: FunnelFlight

Type: boolean

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

Sample Value:

Parameter: ChangeOfGauge

Type: boolean

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

Sample Value:

Parameter: DisclosureCarrier

Type: complexType

Description: Disclosure Carrier is used to return operated flight data

Sample Value:

Parameter: Banner

Type: string

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

Sample Value:

Parameter: Code

Type: string

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

Sample Value:

Parameter: DOT

Type: boolean

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

Sample Value:

Parameter: FareComponent

Type: FareComponentWithId

Description: Fare Component information

Sample Value:

Parameter: CabinType

Type: complexType

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

Sample Value:

Parameter: code

Type: string

Description: Reservation Booking Designator code

Sample Value:

Parameter: sabreCode

Type: string

Description: Reservation Booking Designator Sabre code

Sample Value:

Parameter: name

Type: string

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

Sample Value:

Parameter: shortName

Type: string

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

Sample Value:

Parameter: lang

Type: string

Description: Language of the names

Sample Value:

Parameter: BaggageInformationType

Type: complexType

Description: Information about baggage

Sample Value:

Parameter: Allowance

Type: complexType

Description:

Sample Value:

Parameter: passengerType

Type: string

Description: Type of Passenger

Sample Value:

Parameter: pieces

Type: int

Description: Number of Pieces

Sample Value:

Parameter: weight

Type: int

Description: Weight Limit

Sample Value:

Parameter: unit

Type: string

Description: Units of the Weight Limit

Sample Value:

Parameter: InsuranceOptOut

Type: InsuranceOptOut

Description:

Sample Value:

Parameter: Profile

Type: ProfileType

Description:

Sample Value:

Parameter: PriceSummary

Type: PriceSummaryType

Description:

Sample Value:

Parameter: PriceProvider

Type: PricingProviderType

Description:

Sample Value:

Parameter: PriceSummaryType

Type: complexType

Description:

Sample Value:

Parameter: BasePrice

Type: DecimalPrice

Description:

Sample Value:

Parameter: EquivPrice

Type: DecimalPrice

Description:

Sample Value:

Parameter: TotalTaxes

Type: TaxesType

Description:

Sample Value:

Parameter: TotalPrice

Type: DecimalPrice

Description:

Sample Value:

Parameter: id

Type: int

Description:

Sample Value:

Parameter: refreshTimestamp

Type: dateTime

Description:

Sample Value:

Parameter: TaxesType

Type: complexType

Description:

Sample Value:

Parameter: TaxType

Type: complexType

Description:

Sample Value:

Parameter: TaxAmount

Type: DecimalPrice

Description:

Sample Value:

Parameter: TaxCode

Type: CommonString

Description:

Sample Value:

Parameter: ProductSource

Type: ProductSourceType

Description:

Sample Value:

Parameter: ProductSourceType

Type: complexType

Description:

Sample Value:

Parameter: code

Type: string

Description:

Sample Value:

Parameter: name

Type: string

Description:

Sample Value:

Parameter: vendorName

Type: string

Description:

Sample Value:

Parameter: supplierName

Type: string

Description:

Sample Value:

Parameter: supplierCode

Type: string

Description:

Sample Value:

Parameter: FareComponentWithId

Type: complexType

Description:

Sample Value:

Parameter: FareComponent

Type: int

Description:

Sample Value:

Parameter: FareComponentID

Type: int

Description: Numeric value identifying fare component

Sample Value: