Content Comparison

Flight Booking Retrieval Response contains the latest information about the state of the booking.

OTA_AirBookRS*:

*mandatory

...

Element

...

Attribute

...

Type

...

Description

...

Min…Max occurs

...

PrimaryLangID

...

For more information see Common Data Description section in Glossary.

...

0...1

...

TransactionStatusCode

...

string ("Quote")

...

Indicates the type of request. Must be “Quote” for that step.

...

1...1

...

Success

...

For more information see Common Data Description section in Glossary.

...

Warnings/Warning

...

For more information see Common Data Description section in Glossary.

...

AirReservations

...

Flight Booking Retrieval Response contains the latest information about the state of the booking.

OTA_AirBookRS*:

*mandatory

Element	Attribute	Type	Description	Min…Max occurs
	PrimaryLangID		For more information see Common Data Description section in Glossary.	0...1
	TransactionStatusCode	string ("Quote")	Indicates the type of request. Must be “Quote” for that step.	1...1
Success			For more information see Common Data Description section in Glossary.
Warnings/Warning			For more information see Common Data Description section in Glossary.
AirReservations			Contains information about all flights to be booked.	0...1
	ResStatus	string ("Reserved", "Cancelled", "Issued", "TicketVoid")	Contains current status of the reservation. Possible values are: "Reserved" - means that the PNR exists but no further actions were performed. "Cancelled" - means that PNR is cancelled. "Issued" - means that ticked was issued. "TicketVoid" - means that ticked was voided.	0...1
AirReservations/AirReservation			Contains information about one of the reservation to be booked.	0...*
AirReservations/TotalFare			Uses only in case of multibooking. Contains information about all reservations.	0...1
	Amount*		For more information see Common Data Description section in Glossary.	1...1
	CurrencyCode*		For more information see Common Data Description section in Glossary.	1...1
AirReservations/BookingReferenceID			For more information see Reservation Initiate Request section.	0...1

OTA_AirBookRS/AirReservations/AirReservation:

Element

Attribute

Type

Description

Min…Max occurs

RPH*

integer

A special identifier of requested flight.

1...1

AirItinerary*

A collection of all flight segments requested for booking.

1...1

ActionCode*

string ("Reserved", "Cancelled", "Issued", "TicketVoid")

Indicates status of the reservation. Possible values are:

"Reserved" - means that the PNR exists but no further actions were performed.

"Cancelled" - means that PNR is cancelled.

"Issued" - means that ticked was issued.

"TicketVoid" - means that ticked was voided.

1...1

CodeContext

string

An id of supplier providing offer.

0...1

AirItinerary/OriginDestinationOptions/OriginDestinationOption

For more information see Low Fare Search Response section.

0...*

AirItinerary/OriginDestinationOptions/OriginDestinationOption/FlightSegment*

For more information see Reservation Initiate Response section. Also added the following attributes:

1...*

NotValidBefore

yyyy-mm-dd

Identifies the date before which the fare basis code is not valid.

0...1

NotValidAfter

yyyy-mm-dd

Identifies the date after which the fare basis code is not valid.

0...1

PriceInfo*

Contains special formulas for applying different discounts for the offer.

1…1

FilingAirlineCodeList

string

Contains the list of codes of the validating airlines.

0...1

PricingSource

string ("Published", "Private", "WebFare")

Identifies private fare or not. In case of private fare has "Private" value, also can be "Published". For LCC it has value "WebFare"; otherwise element is absent.

0...1

PriceInfo/ItinTotalFare*

For more information see Reservation Initiate Request section.

PriceInfo/PTC_FareBreakdowns/PTC_FareBreakdown*

For more information see Reservation Initiate Response section.

1...*

PriceInfo/FareInfos/FareInfo

For more information see Reservation Initiate Response section.

0...*

TravelerInfo

Contains information about the travelers for booking.

0...1

TravelerInfo/AirTraveler

For more information see Reservation Initiate Request section.

0...*

TravelerInfo/SpecialReqDetails

For more information see Reservation Initiate Request section.

0...1

ResStatus

string ("Reserved", "Cancelled", "Issued", "TicketVoid")

Contains current status of the reservation. Possible values are:

"Reserved" - means that the PNR exists but no further actions were performed.

"Cancelled" - means that PNR is cancelled.

"Issued" - means that ticked was issued.

"TicketVoid" - means that ticked was voided.

0...1

AirReservations/AirReservation

Contains information about one of the reservation to be booked.

0...*

AirReservations/TotalFare

Uses only in case of multibooking. Contains information about all reservations.

0...1

Amount*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

For more information see Common Data Description section in GlossaryTicketing

Contains ticketing information. If ticket was issued, it contains information about the ticket number, issue date (if provided by supplier) and about current ticket status.

Info
Note: Ticketing is not displayed for Web Fare (LCC) bookings.

0...99

TicketTimeLimit

yyyy-mm-ddThh-mm-ss

Indicates the ticketing arrangement, and allows for the requirement that an itinerary must be ticketed by a certain date and time, including timezone offset.

Info
Very Important Note! Suppliers never provide the timezone offset through XML, so this must be configured in GP Travel HUB credentials before you go live with GP Travel HUB. Please update GP Travel HUB support team about your Office configuration. Otherwise, the offset "+00:00" (GMT) will be used by default, which may be wrong so can affect PNR cancellation process.

Info
Important Note: If supplier returns the TicketTimeLimit the same as the departure date, then GP Travel HUB sets the TicketTimeLimit as the day before departure.

Info
Important Note: if ticket not issued before the TimeLimit specified, the PNR must be cancelled explicitly!

0...1

TicketType*

string ("eTicket")

Indicates type of ticket. Must be "eTicket" only.

1...1

AirReservations/BookingReferenceID

For more information see Reservation Initiate Request section.

0...1

OTA_AirBookRS/AirReservations/AirReservation:

Note: Ticketing is not displayed for Web Fare (LCC) bookings

16

Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier

Status

Element

Attribute

Type

Description

Min…Max occurs

RPH*

integer

A special identifier of requested flight.

1...1

AirItinerary*

A collection of all flight segments requested for booking.

1...1

ActionCode*

string ("Reserved", "Cancelled", "Issued", "TicketVoid")

Indicates status of the reservation. Possible values are:

"Reserved" - means that the PNR exists but no further actions were performed.

"Cancelled" - means that PNR is cancelled.

"Issued" - means that ticked was issued.

"TicketVoid" - means that ticked was voided.

1...1

CodeContext

string

An id of supplier providing offerPseudoCityCode

string

An identification code assigned to an office/agency by a reservation system.

0...1

TicketIssueDate

yyyy-mm-dd T hh-mm-ss

The date when the ticket was issued (if provided by supplier).

Info
Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier.

0...1

TicketingStatus

string ("3", "7")

Identifies current ticket status. Possible values are: "3" - for issued ticket, "7" - for void ticket.

0...1

TicketNumber

string

Contains the ticket number.

0...1

TravelerRefNumber

string

Specifies the traveler ID for this ticket.

0...1

VoidTimeLimit

yyyy-mm-dd T hh-mm-ss

Specifies Void time limit, If provided by supplier.

0...1

AirItinerary/OriginDestinationOptions/OriginDestinationOption

For more information see Low Fare Search Response section

FlightSegmentRefNumber

string

Specifies the segment number for this ticket if need. Returns in response if one passenger have several tickets for several flight segments (if FilingAirlineCodeList attribute contents several airlines).

0...*1

AirItinerary/OriginDestinationOptions/OriginDestinationOption/FlightSegment*

For more information see Reservation Initiate Response section. Also added the following attributes:

1...*

NotValidBefore

yyyy-mm-dd

Identifies the date before which the fare basis code is not validTicketing/TicketingVendor

Contains additional information about tickets

0...1

Code

string (1 - 16)

Identifies a company by the company code.

0...1

NotValidAfterCodeContext

yyyy-mm-ddstring (1 - 32)

Identifies the date after which the fare basis code is not validcontext of the identifying code.

0...1

PriceInfo*

Contains special formulas for applying different discounts for the offer.

1…1

FilingAirlineCodeList

string

Contains the list of codes of the validating airlines.CompanyShortName

string (1 - 32)

Identifies the company common name

0...1

PricingSource

string ("Published", "Private", "WebFare"LocationName

string (1 - 128)

Identifies private fare or not. In case of private fare has "Private" value, also can be "Published". For LCC it has value "WebFare"; otherwise element is absent.company address.

0...1

PriceInfoQueues/ItinTotalFare*Queue

For more information see Reservation Initiate Request section.

PriceInfo/PTC_FareBreakdowns/PTC_FareBreakdown*

For more information see Reservation Initiate Response sectionBookingReferenceID

Contains the unique record number in supplier’s system.

1...*

PriceInfo/FareInfos/FareInfo

For more information see Reservation Initiate Response section.

0...*

TravelerInfo

Contains information about the travelers for booking.

0...1

TravelerInfo/AirTraveler

For more information see Reservation Initiate Request section.

0...*

TravelerInfo/SpecialReqDetails

For more information see Reservation Initiate Request section.

0...1

Ticketing

Contains ticketing information. If ticket was issued, it contains information about the ticket number, issue date (if provided by supplier) and about current ticket status.

Info

ID

string

Unique order number.

1...1

Instance

string ("supplier", "client", "agent", "PNR", "child")

Specifies the instance of the ID.

child - specifies a subsidiary (child) PNR that was created for the rest of IDs that were not mentioned in Initiate request;
supplier - specifies a PNR in supplier's system;
PNR - specifies an original PNR;
client - specifies client's unique identifier;
agent - the ID value is the reservation identifier which client wants to use in communication with supplier.

1...1

ID_Context

string

Contains the supplier's name.

0...99

TicketTimeLimit

yyyy-mm-ddThh-mm-ss

Indicates the ticketing arrangement, and allows for the requirement that an itinerary must be ticketed by a certain date and time, including timezone offset.

Info
Very Important Note! Suppliers never provide the timezone offset through XML, so this must be configured in GP Travel HUB credentials before you go live with GP Travel HUB. Please update GP Travel HUB support team about your Office configuration. Otherwise, the offset "+00:00" (GMT) will be used by default, which may be wrong so can affect PNR cancellation process.

Info
Important Note: If supplier returns the TicketTimeLimit the same as the departure date, then GP Travel HUB sets the TicketTimeLimit as the day before departure.

Info
Important Note: if ticket not issued before the TimeLimit specified, the PNR must be cancelled explicitly!

0...1

TicketType*

string ("eTicket")

Indicates type of ticket. Must be "eTicket" only1

BookingReferenceID/CompanyName

Indicates type of specified PNR.

0...1

Code

string (2 - 3)

Air company code.

0...1

CodeContext

string

Specifies the context of the Code.

0...1

Offer

Contains information about extra service, that are available for booking.

Info
Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier.

0...1

Offer/Priced

Defines the specific extra service.

0...*

ID*

string

Internal ID of this service.

1...1

PseudoCityCodeCarrierCode

stringAn

identification code assigned to an office/agency by a reservation systemContains the code of service's owner.

0...1

TicketIssueDate

yyyy-mm-dd T hh-mm-ss

The date when the ticket was issued (if provided by supplier).

Info

string ("Holds confirmed, EMD required", "Holds confirmed, EMD issued", "Placing on waitlist/new schedule", "Pending confirmation", "Cancelled", "Declined", "Holds confirmed, no EMD required")

Transitional status of service's booking.

0...1

TicketingStatusTravelerRPH

string ("3", "7")Identifies current ticket status. Possible values are: "3" - for issued ticket, "7" - for void ticket

The traveler ID to whom the request applies. If attribute is missed then it means that the service is applies to all passengers.

0...1

TicketNumberFlightSegmentRPHList*

string

Contains the ticket number.0a list of segments for which the service is applicable (there can be several segments).

1...1

TravelerRefNumberMandatoryInd

stringboolean

Specifies the traveler ID for this ticketDefines whether the service is mandatory for booking or not.

0...1

VoidTimeLimit

yyyy-mm-dd T hh-mm-ss

Specifies Void time limit, If provided by supplier.

0...1

FlightSegmentRefNumber

string

Specifies the segment number for this ticket if need. Returns in response if one passenger have several tickets for several flight segments (if FilingAirlineCodeList attribute contents several airlines).

0Name*

string ("Baggage", "Seat assignment", "Meal/Beverage", “Extra“)

OTA name of service.

1...1

Ticketing/TicketingVendor

Contains additional information about tickets

0Offer/Priced/ServiceFamily*

Description of service.

1...1

CodeName

string (1 - 16)Identifies a company by the company code

Describes the name of particular service.

0...1

CodeContext

string (1 - 32)

Identifies the context of the identifying codeOffer/Priced/ServiceFamily/ProductGroup

Contains Code and CodeSource of the service.

0...1*

CompanyShortNameCode

string (1 - 32)Identifies the company common name

0...1

LocationNameCodeSource

string (1 - 128"AirlineInternal", "ATPCO")

Identifies company address.

0...1

Queues/Queue

For more information see Reservation Initiate Request section.

BookingReferenceID

Contains the unique record number in supplier’s system.

1...16

ID

string

Unique order number.

1...1

Instance

string ("supplier", "client", "agent", "PNR", "child")

Specifies the instance of the ID.

child - specifies a subsidiary (child) PNR that was created for the rest of IDs that were not mentioned in Initiate request;

supplier - specifies a PNR in supplier's system;

PNR - specifies an original PNR;

client - specifies client's unique identifier;

agent - the ID value is the reservation identifier which client wants to use in communication with supplier

Offer/Priced/ServiceFamily/ProductGroup/SubGroup

Contains Code and CodeSource of the service.

0...1

Code

string

0...1

CodeSource

string ("AirlineInternal", "ATPCO")

0...1

Offer/Priced/Pricing*

Provides information about cost of service.

1...1

OfferQty*

integer

Number of similar extras requested.

1...1

PreTaxAmount

decimal

Cost of service without taxes.

0...1

Amount*

decimal

Cost of service.

1...1

ID_Context

string

Contains the supplier's name.

0PricingCurrency*

3-character ISO currency code

Currency in which price is nominated.

1...1

BookingReferenceIDOffer/Priced/CompanyNameIndicates type of specified PNR. BookingInstruction

Contains booking and upgrade instructions.

0...1

Code

string (2 - 3)

Air company codeOffer/Priced/BookingInstruction/SSR_Info

Contains code which should be provided for booking.

0...1

CodeContextSSRCode*

string

Specifies the context of the Code.

01...1

Expand

title	Flight Booking Retrieval Quote Response (before ticketing) Sample XML

Code Block

language	xml

<OTA_AirBookRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="EchoToken" TransactionStatusCode="Quote" Version="2.0">
  <Success/>
  <AirReservations>
    <AirReservation RPH="1">
      <AirItinerary ActionCode="Reserved" CodeContext="supplierCode">
        <OriginDestinationOptions>
          <OriginDestinationOption JourneyDuration="PT1H45M0.000S" RPH="1">
            <FlightSegment ArrivalDateTime="2020-11-10T12:45:00" DepartureDateTime="2020-11-10T12:00:00" FlightDuration="PT1H45M0.000S" FlightNumber="906" RPH="11" Status="Have Sold" StopQuantity="0">
              <DepartureAirport LocationCode="FRA" Terminal="1"/>
              <ArrivalAirport LocationCode="LHR" Terminal="2"/>
              <OperatingAirline Code="LH"/>
              <Equipment AirEquipType="32N"/>
              <MarketingAirline Code="LH"/>
              <BookingClassAvails>
                <BookingClassAvail ResBookDesigCode="V"/>
              </BookingClassAvails>
            </FlightSegment>
          </OriginDestinationOption>
          <OriginDestinationOption JourneyDuration="PT1H35M0.000S" RPH="2">
            <FlightSegment ArrivalDateTime="2020-11-12T12:05:00" DepartureDateTime="2020-11-12T09:30:00" FlightDuration="PT1H35M0.000S" FlightNumber="901" RPH="21" Status="Have Sold" StopQuantity="0">
              <DepartureAirport LocationCode="LHR" Terminal="2"/>
              <ArrivalAirport LocationCode="FRA" Terminal="1"/>
              <OperatingAirline Code="LH"/>
              <Equipment AirEquipType="32N"/>
              <MarketingAirline Code="LH"/>
              <BookingClassAvails>
                <BookingClassAvail ResBookDesigCode="V"/>
              </BookingClassAvails>
            </FlightSegment>
          </OriginDestinationOption>
        </OriginDestinationOptions>
      </AirItinerary>
      <PriceInfo FilingAirlineCodeList="LH">
        <ItinTotalFare>
          <BaseFare Amount="148.00" CurrencyCode="KWD"/>
          <Taxes>
            <Tax Amount="115.90" CurrencyCode="KWD" TaxCode="TAX"/>
          </Taxes>
          <TotalFare Amount="263.90" CurrencyCode="KWD"/>
        </ItinTotalFare>
        <PTC_FareBreakdowns>
          <PTC_FareBreakdown FilingAirlineCode="LH">
            <PassengerTypeQuantity Code="ADT" Quantity="1"/>
            <FareBasisCodes>
              <FareBasisCode FlightSegmentRPH="11">VDECLSP1</FareBasisCode>
              <FareBasisCode FlightSegmentRPH="21">VDECLSP1</FareBasisCode>
            </FareBasisCodes>
            <PassengerFare>
              <BaseFare Amount="74.00" CurrencyCode="KWD"/>
              <Taxes>
                <Tax Amount="21.80" CurrencyCode="KWD" TaxCode="YQ"/>
                <Tax Amount="5.85" CurrencyCode="KWD" TaxCode="YR"/>
                <Tax Amount="3.65" CurrencyCode="KWD" TaxCode="DE"/>
                <Tax Amount="9.70" CurrencyCode="KWD" TaxCode="RA"/>
                <Tax Amount="4.70" CurrencyCode="KWD" TaxCode="OY"/>
                <Tax Amount="5.25" CurrencyCode="KWD" TaxCode="GB"/>
                <Tax Amount="7.00" CurrencyCode="KWD" TaxCode="UB"/>
              </Taxes>
              <TotalFare Amount="131.95" CurrencyCode="KWD"/>
              <UnstructuredFareCalc>FRA LH LON115.17LH FRA115.17NUC230.34END ROE0.885647</UnstructuredFareCalc>
            </PassengerFare>
            <BaggageAllowances>
              <BaggageAllowance FlightSegmentRPH="11" UnitOfMeasureCode="PC" UnitOfMeasureQuantity="1"/>
              <BaggageAllowance FlightSegmentRPH="21" UnitOfMeasureCode="PC" UnitOfMeasureQuantity="1"/>
            </BaggageAllowances>
          </PTC_FareBreakdown>
          <PTC_FareBreakdown FilingAirlineCode="LH">
            <PassengerTypeQuantity Age="14" Code="CHD" Quantity="1"/>
            <FareBasisCodes>
              <FareBasisCode FlightSegmentRPH="11">VDECLSP1</FareBasisCode>
              <FareBasisCode FlightSegmentRPH="21">VDECLSP1</FareBasisCode>
            </FareBasisCodes>
            <PassengerFare>
              <BaseFare Amount="74.00" CurrencyCode="KWD"/>
              <Taxes>
                <Tax Amount="21.80" CurrencyCode="KWD" TaxCode="YQ"/>
                <Tax Amount="5.85" CurrencyCode="KWD" TaxCode="YR"/>
                <Tax Amount="3.65" CurrencyCode="KWD" TaxCode="DE"/>
                <Tax Amount="9.70" CurrencyCode="KWD" TaxCode="RA"/>
                <Tax Amount="4.70" CurrencyCode="KWD" TaxCode="OY"/>
                <Tax Amount="5.25" CurrencyCode="KWD" TaxCode="GB"/>
                <Tax Amount="7.00" CurrencyCode="KWD" TaxCode="UB"/>
              </Taxes>
              <TotalFare Amount="131.95" CurrencyCode="KWD"/>
              <UnstructuredFareCalc>FRA LH LON115.17LH FRA115.17NUC230.34END ROE0.885647</UnstructuredFareCalc>
            </PassengerFare>
            <BaggageAllowances>
              <BaggageAllowance FlightSegmentRPH="11" UnitOfMeasureCode="PC" UnitOfMeasureQuantity="1"/>
              <BaggageAllowance FlightSegmentRPH="21" UnitOfMeasureCode="PC" UnitOfMeasureQuantity="1"/>
            </BaggageAllowances>
          </PTC_FareBreakdown>
        </PTC_FareBreakdowns>
        <FareInfos>
          <FareInfo>
            <FareReference>VDECLSP1</FareReference>
            <RuleInfo>
              <GeneralRules>
                <GeneralRule>
                  <Text>VALIDATING CARRIER SPECIFIED - LH CHG BEF DEP UP TO KWD25.410/CHG AFT DEP UP TO KWD25.410/NON-REF BEF DEP/NON-REF AFT DEP/OTHERWISE NON-CHG/SEE RULES</Text>
                </GeneralRule>
              </GeneralRules>
            </RuleInfo>
            <FilingAirline Code="LH"/>
          </FareInfo>
        </FareInfos>
      </PriceInfo>
      <TravelerInfo>
        <AirTraveler BirthDate="1990-01-21" PassengerTypeCode="ADT">
          <ProfileRef>
            <UniqueID ID="1" Type="1"/>
          </ProfileRef>
          <PersonName>
            <NamePrefix>Mr</NamePrefix>
            <GivenName>MASSE</GivenName>
            <Surname>BEGRAVELSER</Surname>
          </PersonName>
          <Telephone PhoneLocationType="8" PhoneNumber="+375999999999"/>
          <Email>test@gpsolutions.com</Email>
          <Document DocHolderNationality="MC" DocID="MP6666666" DocIssueCountry="MC" DocType="P" ExpireDate="2023-01-21" Gender="Male" HolderType="H"/>
        </AirTraveler>
        <AirTraveler BirthDate="2005-12-01" PassengerTypeCode="CHD">
          <ProfileRef>
            <UniqueID ID="2" Type="1"/>
          </ProfileRef>
          <PersonName>
            <NamePrefix>Mr</NamePrefix>
            <GivenName>WIEGE</GivenName>
            <Surname>DOOD</Surname>
          </PersonName>
          <Document DocHolderNationality="MC" DocID="MP9999999" DocIssueCountry="MC" DocType="P" ExpireDate="2022-01-21" Gender="Male" HolderType="H"/>
        </AirTraveler>
        <SpecialReqDetails>
          <SpecialServiceRequests>
            <SpecialServiceRequest SSRCode="FERM" TravelerRefNumberRPHList="1 2">
              <Text>FARE RESTRICTION MAY APPLY</Text>
            </SpecialServiceRequest>
          </SpecialServiceRequests>
        </SpecialReqDetails>
      </TravelerInfo>
      <Ticketing PseudoCityCode="XXYX" TicketTimeLimit="2020-08-21T14:03:00+03:00" TicketType="eTicket"/>
      <BookingReferenceID ID="ight128f8512" Instance="client"/>
      <BookingReferenceID ID="ight128f8512" Instance="agent"/>
      <BookingReferenceID ID="CNUCUX" Instance="supplier"/>
      <BookingReferenceID ID="N4RYEN" Instance="PNR">
        <CompanyName Code="LH" CodeContext="IATA"/>
      </BookingReferenceID>
    </AirReservation>
  </AirReservations>
</OTA_AirBookRS>

...

Version	Old Version 1	New Version 2
Changes made by	Yana Brilevskaya	Yana Brilevskaya
Saved on	Jan 22, 2021	Feb 19, 2021

Versions Compared

Key

OTA_AirBookRS/AirReservations/AirReservation:

OTA_AirBookRS/AirReservations/AirReservation: