10.2. RESERVATION INITIATE RESPONSE
Flight Reservation Initiate Response is returned with fares and rules of a specified flight.
OTA_AirBookRS*:
*mandatory
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
|
| For more information see Common Data Description section in Glossary. | 0...1 | |
TransactionStatusCode | string ("Initiate") | Indicates the type of request. Must be “Initiate“ for that step. | 0...1 | |
TransactionIdentifier* | string | Contains unique transaction identifier. It must be further passed to the Confirmation step. | 1...1 | |
|
| 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") | Indicates common status of all reservations. Possible values are: "Reserved" - means that GP Travel HUB has done the best to ensure that all flights can be booked, however, this status doesn't guarantee, that the flights will be finally booked. It can be "Reserved" only if all reservation in booking have the status "Reserved"; "Request denied" - means that supplier denied this request and flight can not be booked,if at least one reservation has status "Request denied" the common status will be "Request denied". | 0...1 | |
|
| Contains information about one of the flight to be booked. | 0...* | |
AirReservations/TotalFare |
|
| Uses only in case of multibooking. Contains information about all reservations. | 0...1 |
| For more information see Common Data Description section in Glossary. | 1...1 | ||
| 1...1 | |||
|
| 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. | 0...* |
BookingCode* | string | Unique offer identifier. Please note that the BookingCode in Reservation Initiate response may change. | 1...1 | |
ActionCode* | string ("Reserved", "Request denied") | Indicates status of the reservation. Possible values are: "Reserved" - means that GP Travel HUB has done the best to ensure that the flight can be booked, however, this status doesn't guarantee, that the flight will be finally booked. "Request denied" - means that supplier denied this request and flight can not be booked. | 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* |
|
| A container for necessary data to describe legs of a single flight. | 1...* |
|
| Contains special formulas for applying different discounts for the offer. |
| |
TravelerInfo |
|
| Contains information about the travelers for booking. | 0...1 |
|
| For more information see Reservation Initiate Request section. | 0...* | |
|
| For more information see Reservation Initiate Request section. | 0...1 | |
Ticketing |
|
| Contains ticketing information. | 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. 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. 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. 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 | |
|
| For more information see Reservation Initiate Request section. |
| |
|
| For more information see Reservation Initiate Request section. |
| |
Offer |
|
| Contains information about extra service, that are available for booking. | 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") | Transitional status of service's booking. In current implementation on this particular step will always have value Pending confirmation (means aircompany hasn't confirmed yet this service). | 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 | |
IsPerBooking | boolean (default - false) | Defines whether the service applies to the entire offer or to a specific passenger. | 0..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 | |
TaxAmount | decimal | Cost of service with taxes. | 0…1 | |
Amount* | decimal | Cost of service. | 1...1 | |
PricingCurrency* | 3-character ISO currency code | Currency in which price is nominated. | 1...1 | |
Priced/Pricing/TaxInfo |
|
| Contains information about taxes. | 0…99 |
Code* |
| Contains service code | 1…1 | |
Amount* |
| Contains amount of tax | 1…1 | |
CurrencyCode* |
| Currency in which tax 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 |
OTA_AirBookRS/AirReservations/AirReservation/AirItinerary/OriginDestinationOptions/OriginDestinationOption/FlightSegment*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
| ArrivalDateTime* | YYYY-MM-DD T hh:mm:ss. | Contains arrival date and local time in the arrival airport. | 1..1 |
DepartureDateTime* | YYYY-MM-DD T hh:mm:ss. | Contains departure date and local time in the departure airport. | 1..1 | |
StopQuantity* | integer | Indicates the number of stops. | 1..1 | |
FlightNumber* | integer | The flight number. | 1..1 | |
RPH* | integer | The flight segment unique ID. | 1..1 | |
Status | string | Status of a single flight. For more information about its values see Air Segment Status Codes. | 0...1 | |
StatusCode | string | GDS segment status code. | 0...1 | |
FlightDuration | PTnHnMnS | Contains flight duration in format. | 0..1 | |
DepartureAirport* |
|
| Identifies departure point of flight segment. | 1..1 |
| For more information see Common Data Description section in Glossary. | 1...1 | ||
| 0...1 | |||
ArrivalAirport* |
|
| Identifies arrival point of flight segment. | 1..1 |
| For more information see Common Data Description section in Glossary. | 1...1 | ||
| 0...1 | |||
|
| 1..1 | ||
|
| 0..1 | ||
|
| 1..1 | ||
|
|
| ||
|
| 0...9 |
OTA_AirBookRS/AirReservations/AirReservation/PriceInfo*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
| 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 Booking Commit will be the final step of the booking process and additional warning message about that is displayed to warn a client. | 0...1 | |
|
| For more information see Reservation Initiate Request section. |
| |
|
| Contains fare breakdowns per passenger. | 1...* | |
|
| Contains textual information on individual priced fares. | 0...* |
OTA_AirBookRS/AirReservations/AirReservation/PriceInfo/PTC_FareBreakdowns/PTC_FareBreakdown*:
Contains the same elements as in Low Fare Search Response, but the following elements should be added:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
AirTravelerUniqueIDs |
|
| List of airtraveler unique IDs for which FareBreakdown applies. | 0...1 |
AirTravelerUniqueIDs/AirTravelerUniqueID* |
| positive integer | Airtraveler unique ID for which FareBreakdown applies. | 1...* |
PassengerFare/UnstructuredFareCalc |
| string 1 - 128 | Contains especially encrypted calculation of fare. All air companies have the same calculation structure. | 0...1 |
FareCalcMode | string 1 | Is used to identify the method of pricing for this transaction (e.g., manual, automated pricing). | 0...1 |
OTA_AirBookRS/AirReservations/AirReservation/PriceInfo/FareInfos/FareInfo:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
FareReference |
| string | Identifies the fare code. | 0...5 |
AccountCode | string 1 - 32 | Identifies corporate fare code. | 0...1 | |
FlightSegmentRPHList | string | For more information see Common Data Description section in Glossary. | 0...1 | |
BrandName | string | Defines the name of brand, to which the fare belongs. | 0...1 | |
RuleInfo |
|
| A collection of rules applied to the fare. | 0...1 |
RuleInfo/GeneralRules/GeneralRule |
|
| Contains information about general rule provided by airline. | 0...* |
RuleInfo/GeneralRules/GeneralRule/Text |
| string | Contains the rule description. | 0...1 |
FilingAirline |
|
| The Code of the validating airline published the fare. | 0...1 |
Code* | string | Contains IATA airline code. | 1...1 | |
|
| For more information see Flight Pricing Upsell section. | 0...* |