API Information

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

What's New

  • PQ Fare Component data
  • Disclosure Carrier support
  • Change of Gauge indicator
  • Hidden Stop, Elapsed Time and Air Miles Flown for flight
  • Open Reservation xml schema has been imported to GetReservationRS

New Features

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:

Parameter: FareDirectionality

Type: string

Description: Fare Directionality is used to return Directionality of Fare used for particular Fare Component (TO; FROM)

Sample Value:

Parameter: TicketDesignator

Type: string

Description: TicketDesignator is used to return Ticket Designator Code attached to Fare Basis Code.

Sample Value:

Parameter: ShortName

Type: string

Description: is used to return short name of the Reservation booking designator (i.e PR ECON)

Sample Value:

Parameter: ID

Type: string

Description: is used to return Id of the ski booking data

Sample Value:

Parameter: code

Type: string

Description: is used to return additional ski data

Sample Value:

Parameter: name

Type: string

Description: is used to return additional ski data

Sample Value:

Parameter: ReceivingCarrierCode

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: VitType

Type: short

Description: is used to return open reservation element data

Sample Value:

In the Response

Required

Parameter: Type

Type: string

Description: used to return information about deal type

Sample Value:

Optional

Parameter: Language

Type: boolean

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

Sample Value:

Parameter: id

Type: UniqueIdentifier

Description: Unique id

Sample Value:

Parameter: op

Type: OperationType

Description: Operation Type (C = Create, U = Update, D = Delete)

Sample Value:

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:

Parameter: FareComponent

Type: complex

Description: Fare Component is used to return Fare Component Data

Sample Value:

Parameter: Location

Type: complex

Description: Location is used to return Origin and Destination for Fare component

Sample Value:

Parameter: Origin

Type: string

Description: Origin is used to return origin of Fare Component

Sample Value:

Parameter: Destination

Type: string

Description: Destination is used to return Destination of Fare Component

Sample Value:

Parameter: Dates

Type: complex

Description: Dates are used to return departure and arrival date and time of Fare Component

Sample Value:

Parameter: DepartureDateTime

Type: srting

Description: Departure Date Time is used to return departure date and time of Fare Component

Sample Value:

Parameter: FlightSegmentNumbers

Type: complex

Description: Fare Segment Numbers are used to return flights associated with Fare Component

Sample Value:

Parameter: FlightSegmentNumber

Type: string

Description: FareSegmentNumber is used to return single flight associated with Fare Component

Sample Value:

Parameter: FareBasisCode

Type: string

Description: Fare Basis Code is used to return Fare Basis Code of Fare Component

Sample Value:

Parameter: Amount

Type: string

Description: Amount is used to return NUC amount for particular Fare Component

Sample Value:

Parameter: GoverningCarrier

Type: string

Description: used to return Governing Carrier Code (e.g. EY, AA, LH)

Sample Value:

Parameter: FareComponentNumber

Type: string

Description: used to display number of fare component stored in PQ

Sample Value:

Parameter: RuleName

Type: string

Description: used to return rule details

Sample Value:

Parameter: Deal

Type: complex

Description: used to return information about applied discount/markup for this ancillary

Sample Value:

Parameter: Percentage

Type: decimal

Description: used to return information defined in RULE for percentage discounts/markups

Sample Value:

Parameter: Amount

Type: decimal

Description: used to return information defined in RULE for monetary discounts/markups

Sample Value:

Parameter: Currency

Type: string

Description: used to return information defined in RULE for monetary discounts/markups

Sample Value:

Parameter: RuleId

Type: string

Description: used to return Rule Id

Sample Value:

Parameter: DisclosureCarrier

Type: complex

Description: used to return operated flight data

Sample Value:

Parameter: Banner

Type: string

Description: used to return the disclosure carrier message

Sample Value:

Parameter: Code

Type: string

Description: used to return the disclosure carrier code associated with the particular flight segment

Sample Value:

Parameter: DOT

Type: boolean

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

Sample Value:

Parameter: ElapsedTime

Type: string

Description: used to return the elapsed time associated with the particular flight segment

Sample Value:

Parameter: AirMilesFlown

Type: string

Description: used to return the air miles flown associated with the particular flight segment

Sample Value:

Parameter: HiddenStop

Type: complex

Description: used to return Hidden stop details (Airport, Date of arrival/departure)

Sample Value:

Parameter: ArrivalDateTime

Type: string

Description: used to return arrival date and time from Hidden Stop

Sample Value:

Parameter: DepartureDateTime

Type: string

Description: used to return departure date and time from Hidden Stop

Sample Value:

Parameter: Airport

Type: string

Description: used to determine airport location code

Sample Value:

Parameter: FunnelFlight

Type: boolean

Description: used to determine if a flight is a funnel flight type

Sample Value:

Parameter: ChangeOfGauge

Type: boolean

Description: used to determine a funnel flight type for flight segment

Sample Value:

Parameter: InstantPurchase

Type: boolean

Description: Indication of LCC segment. (e.g. FALSE)

Sample Value:

Parameter: BrandID

Type: BrandIDType

Description: 2 Chars string representing sold brand. (e.g. PE)

Sample Value:

Parameter: Cabin

Type: complex

Description: is used to return cabin code

Sample Value:

Parameter: Code

Type: string

Description: is used to return Reservation Booking Designator code for cabin

Sample Value:

Parameter: SabreCode

Type:

Description: is used to return Reservation Booking Designator sabre code for cabin

Sample Value:

Parameter: Name

Type: string

Description: is used to return long name of the Reservation booking designator (i.e Premium Economy)

Sample Value:

Parameter: Lang

Type: string

Description: is used to return Language of the names for Cabin

Sample Value:

Parameter: Loyalty

Type: Loyalty

Description: is used to return loyalty data

Sample Value:

Parameter: FrequentFlayer

Type: FrequentFlayer

Description: is used to return FF data

Sample Value:

Parameter: PriceCache

Type: PriceCache

Description: is used to return Pricing data

Sample Value:

Parameter: TripProposalReference

Type: TripProposalReference

Description: is used to link Trip Proposal to PNR

Sample Value:

Parameter: Loyalty

Type: string

Description: is used to return loyalty data

Sample Value:

Parameter: ServiceRequest

Type: string

Description: is used to return request data

Sample Value:

Parameter: Email

Type: string

Description: is used to return Email data

Sample Value:

Parameter: PriceCache

Type: string

Description: is used to return Pricing data

Sample Value:

Parameter: InsuranceOptOut

Type: string

Description: is used to return insurance data

Sample Value:

Parameter: TripProposalReference

Type: string

Description: is used to return Trip Proposal data

Sample Value:

Parameter: Visa

Type: VisaType

Description: is used to return Visa data

Sample Value:

Parameter: Insurance

Type: InsuranceType

Description: is used to return insurance data

Sample Value:

Parameter: Vehicle

Type: VehicleType

Description: is used to return car data

Sample Value:

Parameter: Other

Type: OtherType

Description: is used to return other data

Sample Value:

Parameter: Ski

Type: SkiType

Description: is used to return ski data

Sample Value:

Parameter: comment

Type: string

Description: is used to return comments

Sample Value:

Parameter: VisaType

Type: ComplexType

Description: is used to return Visa type data

Sample Value:

Parameter: CustomerResponsibility ID

Type: string

Description: is used to return id data

Sample Value:

Parameter: Rates

Type: complexType

Description: is used to return rate data

Sample Value:

Parameter: FOP

Type: string

Description: is used to return form of payment data

Sample Value:

Parameter: amount

Type: decimal

Description: is used to return rates amount

Sample Value:

Parameter: currency

Type: string

Description: is used to return currency code for rates amount

Sample Value:

Parameter: ServiceFee

Type: complexType

Description: is used to return fee data

Sample Value:

Parameter: amount

Type: decimal

Description: is used to return service fee amount

Sample Value:

Parameter: currency

Type: string

Description: is used to return service fee currency

Sample Value:

Parameter: DestinationCountry

Type: complexType

Description: is used to return destination data

Sample Value:

Parameter: code

Type: string

Description: is used to return destination country code

Sample Value:

Parameter: name

Type: string

Description: is used to return Destination Country name

Sample Value:

Parameter: ProcessingTime

Type: complexType

Description: is used to return processing time data

Sample Value:

Parameter: Duration

Type: string

Description: is used to return duration of processing time

Sample Value:

Parameter: used to return duration of processing time

Type: string

Description: is used to return notes

Sample Value:

Parameter: Unit

Type: string

Description: is used to return processing time unit data

Sample Value:

Parameter: Purpose

Type: complexType

Description: is used to return additional visa data

Sample Value:

Parameter: Comments

Type: string

Description: is used to return additional visa data

Sample Value:

Parameter: Transit

Type: complexType

Description: is used to return additional visa data

Sample Value:

Parameter: City

Type: complexType

Description: is used to return additional visa data

Sample Value:

Parameter: name

Type: string

Description: is used to return additional visa data

Sample Value:

Parameter: Vendor

Type: complexType

Description: is used to return additional visa data

Sample Value:

Parameter: Name

Type: string

Description: is used to return additional visa data

Sample Value:

Parameter: Duration

Type: string

Description: is used to return additional visa data

Sample Value:

Parameter: Payment

Type: string

Description: is used to return additional visa data

Sample Value:

Parameter: Receiver

Type: string

Description: is used to return additional visa data

Sample Value:

Parameter: PricingElements

Type: PricingElementsType

Description: is used to return additional visa data

Sample Value:

Parameter: Ski

Type: complexType

Description: is used to return ski data

Sample Value:

Parameter: Booking

Type: complexType

Description: is used to return ski data

Sample Value:

Parameter: ChangePolicy

Type: complexType

Description: is used to return ski change policy data

Sample Value:

Parameter: Conditions

Type: string

Description: is used to return ski change policy conditions data

Sample Value:

Parameter: ConditionsDefault

Type: string

Description: is used to return additional ski data

Sample Value:

Parameter: City

Type: complexType

Description: is used to return additional ski data

Sample Value:

Parameter: ClothingHire

Type: complexType

Description: is used to return additional ski data

Sample Value:

Parameter: Item

Type: is used to return additional ski data

Description: is used to return additional ski data

Sample Value:

Parameter: EquipmentHire

Type: SkiCommonElementsType

Description: is used to return additional ski data

Sample Value:

Parameter: Extras

Type: SkiCommonElementsType

Description: is used to return additional ski data

Sample Value:

Parameter: Lessons

Type: SkiCommonElementsType

Description: is used to return additional ski data

Sample Value:

Parameter: LiftPass

Type: SkiCommonElementsType

Description: is used to return additional ski data

Sample Value:

Parameter: Location

Type: complexType

Description: is used to return additional ski data

Sample Value:

Parameter: Regions

Type: complexType

Description: is used to return additional ski data

Sample Value:

Parameter: name

Type: string

Description: is used to return additional ski data

Sample Value:

Parameter: Resort

Type: complexType

Description: is used to return additional ski data

Sample Value:

Parameter: name

Type: string

Description: is used to return additional ski data

Sample Value:

Parameter: Vendor

Type: complexType

Description: is used to return additional ski data

Sample Value:

Parameter: code

Type: string

Description: is used to return additional ski data

Sample Value:

Parameter: name

Type: string

Description: is used to return additional ski data

Sample Value:

Parameter: Transfers

Type: complexType

Description: is used to return additional ski data

Sample Value:

Parameter: Description

Type: string

Description: is used to return additional ski data

Sample Value:

Parameter: PricingElements

Type: PricingElementsType

Description: is used to return additional ski data

Sample Value:

Parameter: LateDeparturePolicy

Type: string

Description: is used to return additional Hotel product data

Sample Value:

Parameter: PricingElements

Type: PricingElementsType

Description: is used to return additional Hotel product data

Sample Value:

Parameter: LateDepartureRequired

Type: boolean

Description: is used to return additional Hotel product data

Sample Value:

Parameter: SeatNumber

Type: string

Description: is used to return additional rail product data

Sample Value:

Parameter: TypeOfPass

Type: string

Description: is used to return additional rail product data

Sample Value:

Parameter: DateOfBirth

Type: date

Description: is used to return additional data for ground transportation product

Sample Value:

Parameter: Profile

Type: complexType

Description: is used to return additional ground transportation product data

Sample Value:

Parameter: ID

Type: string

Description: is used to return additional ground transportation product data

Sample Value:

Parameter: Type

Type: string

Description: is used to return additional ground transportation product data

Sample Value:

Parameter: source

Type: string

Description: is used to return additional ground transportation product data

Sample Value:

Parameter: PriceCache

Type: complexType

Description: is used to return open reservation element data

Sample Value:

Parameter: ProviderName

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: Comment

Type: complexType

Description: is used to return open reservation element data

Sample Value:

Parameter: name

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: type

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: ProviderRequest

Type: complexType

Description: is used to return open reservation element data

Sample Value:

Parameter: ProviderResponse

Type: complexType

Description: is used to return open reservation element data

Sample Value:

Parameter: Loyalty

Type: complexType

Description: is used to return open reservation element data

Sample Value:

Parameter: ProgramName

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: MembershipID

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: LoyaltyLevel

Type: CodeDescription

Description: is used to return open reservation element data

Sample Value:

Parameter: Code

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: EffectiveDate

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: ExpireDate

Type: dateTime

Description: is used to return open reservation element data

Sample Value:

Parameter: Remark

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: Metadata

Type: complexType

Description: is used to return open reservation element data

Sample Value:

Parameter: DisplayIndex

Type: int

Description: is used to return open reservation element data

Sample Value:

Parameter: FrequentFlyer

Type: complexType

Description: is used to return open reservation element data

Sample Value:

Parameter: PartnershipAirlineCodes

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: ActionCode

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: PreviousActionCode

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: Vendor

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: FrequentFlyerNumber

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: MembershipID

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: ProductType

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: ProgramCode

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: Provider

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: CITierLevel

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: ATPCOTierLevel

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: Indicators

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: Text

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: Banner

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: Tag

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: Tag2Char

Type: string

Description: is used to return open reservation element data

Sample Value:

Parameter: PriceQuoteType

Type: complexType

Description: is used to return PQ open reservation element data

Sample Value: