Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: offer/status description was added

Reservation Confirmation Response returns information about booking that has been made, its status and reservation IDs.

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 ("Book")

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

1...1

TransactionIdentifier*

string

Contains unique transaction identifier returned in the Reservation Initiate Response.

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", "Request denied", "Issued")

Indicates status of the reservation. Possible values are:

"Reserved" - means that the PNR created successfully.

"Request denied" - means that supplier denied this request and flight can not be booked.

"Issued" - this status is available for Web Fare (LCC) bookings only. Which means that the booking was reserved and a ticket was issued.

Info

Important note the common ResStatus is "the worst status" among all reservations in basket:

Only if all reservation in booking have the status "Reserved" the common status will be "Reserved"

If at least one reservation has status "Request denied" the common status will be "Request denied".

0...1

AirReservations/AirReservation

Contains information about one of the reservation to be booked.

0...1

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

...

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

BookingCode*

string

Unique offer identifier.

1...1

ActionCode*

string ("Reserved", "Request denied", “Issued”)

Indicates status of the reservation. Possible values are:

"Reserved" - means that the PNR created successfully.

"Request denied" - means that supplier denied this request and flight can not be booked.

"Issued" - this status is available for Web Fare (LCC) bookings only. Which means that the booking was reserved and a ticket was issued.

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.

1...*

PriceInfo*

Contains special formulas for applying different discounts for the offer.

1…1

FilingAirlineCodeList

string

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 the value "WebFare", which means that Flight Reservation Confirmation will be the final step of the booking process and additional warning message about that is displayed to warn a client.

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

Ticketing

Contains ticketing information.

0...1

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

PseudoCityCode

string

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

0...1

Queues/Queue

For more information see Reservation Initiate Request section.

BookingReferenceID

Contains information about reservation identifiers.

1...5

ID*

string

A value of booking reference.

1...1

Instance*

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

Indicates type of BookingReference ID. The “client” context means that the ID value is the unique reservation identifier in the client system. The “agent” context means that the ID value is the reservation identifier which client wants to use in communication with supplier. The”supplier” context contains the unique record number in supplier’s system.

1...1

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

CarrierCode

string

Contains the code of service's owner.

0...1

Status

string ("Pending confirmation", "Holds confirmed, EMD required", "Declined", "Holds confirmed, no EMD required")

Transitional status of service's booking.

"Pending confirmation" - means that the aircompany hasn't confirmed this service yet.

"Holds confirmed, EMD required" - means that the aircompany has confirmed this service. And EMD should be issued. In that case client should call Flight Ticketing.

"Declined" - means that servise was declined (service was never Holds confirmed).

"Holds confirmed, no EMD required" - special service status that means that the booking is completed. EMD is not required.

0...1

TravelerRPH

string

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

FlightSegmentRPHList*

string

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

1...1

MandatoryInd

boolean

Defines whether the service is mandatory for booking or not.

0...1

Name*

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

OTA name of service.

1...1

Offer/Priced/ServiceFamily*

Description of service.

1...1

Name

string

Describes the name of particular service.

0...1

Offer/Priced/ServiceFamily/ProductGroup

Contains Code and CodeSource of the service.

0...*

Code

string

0...1

CodeSource

string ("AirlineInternal", "ATPCO")

0...1

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

PricingCurrency*

3-character ISO currency code

Currency in which price is nominated.

1...1

Offer/Priced/BookingInstruction

Contains booking and upgrade instructions.

0...1

Offer/Priced/BookingInstruction/SSR_Info

Contains code which should be provided for booking.

0...1

SSRCode*

string

1...1

Expand
titleFlight Reservation Confirmation Response (by client) Sample XML - 2 ADT 1 CHD
Code Block
languagexml
<OTA_AirBookRS Version="2.0" TransactionStatusCode="Book" TransactionIdentifier="4350" EchoToken="12345" xmlns="http://www.opentravel.org/OTA/2003/05">
   <Success/>
   <AirReservations ResStatus="Reserved">
      <AirReservation RPH="1">
         <AirItinerary BookingCode="6d05da" ActionCode="Reserved" CodeContext="supplierCode">
            <OriginDestinationOptions>
               <OriginDestinationOption RPH="1">
                  <FlightSegment RPH="11" Status="Have Sold" FlightNumber="4903" StopQuantity="0" FlightDuration="PT2H45M0.000S" DepartureDateTime="2020-07-12T11:45:00" ArrivalDateTime="2020-07-12T12:25:00">
                     <DepartureAirport Terminal="F" LocationCode="SVO"/>
                     <ArrivalAirport Terminal="1" LocationCode="PRG"/>
                     <OperatingAirline Code="SU"/>
                     <Equipment AirEquipType="320"/>
                     <MarketingAirline Code="OK"/>
                     <BookingClassAvails>
                        <BookingClassAvail ResBookDesigCode="X" ResBookDesigName="Economy"/>
                     </BookingClassAvails>
                  </FlightSegment>
                  <FlightSegment RPH="12" Status="Have Sold" FlightNumber="726" DepartureDateTime="2020-07-12T20:15:00" ArrivalDateTime="2020-07-12T22:00:00">
                     <DepartureAirport Terminal="2" LocationCode="PRG"/>
                     <ArrivalAirport Terminal="3" LocationCode="FCO"/>
                     <MarketingAirline Code="OK"/>
                     <BookingClassAvails>
                        <BookingClassAvail ResBookDesigCode="X"/>
                     </BookingClassAvails>
                  </FlightSegment>
               </OriginDestinationOption>
            </OriginDestinationOptions>
         </AirItinerary>
         <PriceInfo FilingAirlineCodeList="AF">
            <ItinTotalFare>
               <BaseFare CurrencyCode="RUB" Amount="24480.00"/>
               <Taxes>
                  <Tax CurrencyCode="RUB" Amount="7680.00" TaxCode="AC"/>
                  <Tax CurrencyCode="RUB" Amount="1626.00" TaxCode="DP"/>
                  <Tax CurrencyCode="RUB" Amount="576.00" TaxCode="SE"/>
                  <Tax CurrencyCode="RUB" Amount="1884.00" TaxCode="EB"/>
                  <Tax CurrencyCode="RUB" Amount="90.00" TaxCode="AD"/>
                  <Tax CurrencyCode="RUB" Amount="246.00" TaxCode="AE"/>
                  <Tax CurrencyCode="RUB" Amount="660.00" TaxCode="CO"/>
                  <Tax CurrencyCode="RUB" Amount="1884.00" TaxCode="EB"/>
                  <Tax CurrencyCode="RUB" Amount="576.00" TaxCode="SE"/>
               </Taxes>
               <TotalFare CurrencyCode="RUB" Amount="37989.00"/>
            </ItinTotalFare>
            <PTC_FareBreakdowns>
               <PTC_FareBreakdown>
                  <PassengerTypeQuantity Quantity="2" Code="ADT"/>
                  <FareBasisCodes>
                     <FareBasisCode FlightSegmentRPH="11">XSK</FareBasisCode>
                     <FareBasisCode FlightSegmentRPH="12">XSK</FareBasisCode>
                  </FareBasisCodes>
                  <PassengerFare>
                     <BaseFare CurrencyCode="RUB" Amount="9160.00"/>
                     <Taxes>
                        <Tax CurrencyCode="RUB" Amount="2560.00" TaxCode="AC"/>
                        <Tax CurrencyCode="RUB" Amount="542.00" TaxCode="DP"/>
                        <Tax CurrencyCode="RUB" Amount="192.00" TaxCode="SE"/>
                        <Tax CurrencyCode="RUB" Amount="628.00" TaxCode="EB"/>
                        <Tax CurrencyCode="RUB" Amount="30.00" TaxCode="AD"/>
                        <Tax CurrencyCode="RUB" Amount="82.00" TaxCode="AE"/>
                        <Tax CurrencyCode="RUB" Amount="220.00" TaxCode="CO"/>
                        <Tax CurrencyCode="RUB" Amount="211.00" TaxCode="EB"/>
                        <Tax CurrencyCode="RUB" Amount="73.00" TaxCode="SE"/>
                     </Taxes>
                     <TotalFare CurrencyCode="RUB" Amount="13698.00"/>
                  </PassengerFare>
                  <BaggageAllowances>
                     <BaggageAllowance FlightSegmentRPH="11" UnitOfMeasureCode="K" UnitOfMeasureQuantity="20"/>
                  </BaggageAllowances>
               </PTC_FareBreakdown>
               <PTC_FareBreakdown>
                  <PassengerTypeQuantity Quantity="1" Code="CHD"/>
                  <FareBasisCodes>
                     <FareBasisCode FlightSegmentRPH="11">XSKYRU</FareBasisCode>
                     <FareBasisCode FlightSegmentRPH="12">XSKYRU</FareBasisCode>
                  </FareBasisCodes>
                  <PassengerFare>
                     <BaseFare CurrencyCode="RUB" Amount="6160.00"/>
                     <Taxes>
                        <Tax CurrencyCode="RUB" Amount="2560.00" TaxCode="AC"/>
                        <Tax CurrencyCode="RUB" Amount="542.00" TaxCode="DP"/>
                        <Tax CurrencyCode="RUB" Amount="192.00" TaxCode="SE"/>
                        <Tax CurrencyCode="RUB" Amount="628.00" TaxCode="EB"/>
                        <Tax CurrencyCode="RUB" Amount="30.00" TaxCode="AD"/>
                        <Tax CurrencyCode="RUB" Amount="82.00" TaxCode="AE"/>
                        <Tax CurrencyCode="RUB" Amount="220.00" TaxCode="CO"/>
                        <Tax CurrencyCode="RUB" Amount="106.00" TaxCode="EB"/>
                        <Tax CurrencyCode="RUB" Amount="73.00" TaxCode="SE"/>
                     </Taxes>
                     <TotalFare CurrencyCode="RUB" Amount="10593.00"/>
                  </PassengerFare>
                  <BaggageAllowances>
                     <BaggageAllowance FlightSegmentRPH="11" UnitOfMeasureCode="K" UnitOfMeasureQuantity="20"/>
                  </BaggageAllowances>
               </PTC_FareBreakdown>
            </PTC_FareBreakdowns>
            <FareInfos>
               <FareInfo>
                  <FareReference>XSKYRU</FareReference>
                  <RuleInfo>
                     <ChargesRules>
                        <VoluntaryChanges VolChangeInd="true">
                           <Penalty Percent="100"/>
                           <Text>Applied</Text>
                        </VoluntaryChanges>
                     </ChargesRules>
                     <GeneralRules>
                        <GeneralRule>
                           <Text>ADV OFFER</Text>
                        </GeneralRule>
                        <GeneralRule>
                           <Text>NON-REFUNDABLE</Text>
                        </GeneralRule>
                     </GeneralRules>
                  </RuleInfo>
                  <FilingAirline Code="HP"/>
               </FareInfo>
               <FareInfo>
                  <FareReference>USPCRU</FareReference>
                  <RuleInfo>
                     <ChargesRules>
                        <VoluntaryChanges VolChangeInd="true">
                           <Penalty Percent="100"/>
                           <Text>Applied</Text>
                        </VoluntaryChanges>
                     </ChargesRules>
                  </RuleInfo>
                  <FilingAirline Code="HP"/>
               </FareInfo>
            </FareInfos>
         </PriceInfo>
         <TravelerInfo>
            <AirTraveler PassengerTypeCode="ADT">
               <ProfileRef>
                  <UniqueID ID="1" Type="1"/>
               </ProfileRef>
               <PersonName>
                  <NamePrefix>Mr</NamePrefix>
                  <GivenName>Nick</GivenName>
                  <Surname>Farrel</Surname>
               </PersonName>
               <Document ExpireDate="2025-12-11" EffectiveDate="2017-12-11" Gender="Male" DocType="P" DocIssueLocation="GB" DocID="11111" DocHolderNationality="GB"/>
            </AirTraveler>
            <AirTraveler PassengerTypeCode="ADT">
               <ProfileRef>
                  <UniqueID ID="2" Type="1"/>
               </ProfileRef>
               <PersonName>
                  <NamePrefix>Ms</NamePrefix>
                  <GivenName>Helen</GivenName>
                  <Surname>Farrel</Surname>
               </PersonName>
               <Document ExpireDate="2025-12-11" EffectiveDate="2017-12-11" Gender="Female" DocType="P" DocIssueLocation="GB" DocID="11111" DocHolderNationality="GB"/>
            </AirTraveler>
            <AirTraveler PassengerTypeCode="CHD">
               <ProfileRef>
                  <UniqueID ID="3" Type="1"/>
               </ProfileRef>
               <PersonName>
                  <NamePrefix>Mr</NamePrefix>
                  <GivenName>Boy</GivenName>
                  <Surname>Farrel</Surname>
               </PersonName>
               <Document ExpireDate="2025-12-11" EffectiveDate="2017-12-11" Gender="Male" DocType="P" DocIssueLocation="GB" DocID="11111" DocHolderNationality="GB"/>
            </AirTraveler>
         </TravelerInfo>
         <Ticketing TicketType="eTicket" TicketTimeLimit="2020-05-20T00:00:00-04:00" PseudoCityCode="XXXX000YY"/>
         <BookingReferenceID ID="G001456" Instance="supplier"/>
         <BookingReferenceID ID="ol1" Instance="agent"/>
         <BookingReferenceID ID="ol1" Instance="client"/>
      </AirReservation>
   </AirReservations>
</OTA_AirBookRS>

...