Hold GDS
Book method is to hold the Booking of Non LCC airline. Every Non LCC airline must be Hold first before ticketing. It will not work for LCC airline because LCC airline is ticketed directly. Price verification is done before creating a booking and PNR No. is returned in case of a successful booking. In case of Price change or Time change, you will get new fare and/or new time in Book response with IsPriceChanged node and/or IsTimeChanged node set as 'true'.
The price comparison is to be made at the client’s end, and Book request needs to be sent again with the updated fare and/ or updated time. Passenger’s Date of Birth and Passport details are optional in book request wherever applicable. However, if not provided in book request then the same needs to be provided in Ticket request.
Service URL (REST) to be used:
Hold GDS Request
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | EndUserIp | String | IP Address of the End User | Mandatory |
| 2 | ClientId | String | Client ID provided to the agency at registration | Mandatory |
| 3 | UserName | String | Username provided to the agency at registration | Mandatory |
| 4 | Password | String | Password provided to the agency at registration | Mandatory |
| 5 | SrdvType | String | Simple result data version | Mandatory |
| 6 | SrdvIndex | String | Simple result data version index | Mandatory |
| 7 | TraceId | String | Trace Id | Mandatory |
| 8 | ResultIndex | String | Result Index | Mandatory |
| 9 | Passengers[] | Array | Passengers | Mandatory |
| 9.1 | Title | String | Title | Mandatory |
| 9.2 | FirstName | String | First Name | Mandatory |
| 9.3 | LastName | String | LastName | Mandatory |
| 9.4 | PaxType | String | Pax Type ( 1- Adult, 2- Child, 3- Infant ) | Mandatory |
| 9.5 | DateOfBirth | Date Time | Date Of Birth | Optional |
| 9.6 | Gender | String | Gender ( 1 – Male, 2 – Female) | Mandatory |
| 9.7 | PassportNo | String | Passport No | Optional |
| 9.8 | PassportExpiry | Date Time | Passport expiry | Optional |
| 9.9 | AddressLine1 | String | Address (Max of 32 characters) | Mandatory |
| 9.10 | City | String | City | Mandatory |
| 9.11 | CountryCode | String | Passport Issue Country Code, (ISO 3166-1 alpha-2 (2-letter code)) Example: India → IN | Mandatory |
| 9.12 | CountryName | String | Country Name | Mandatory |
| 9.13 | ContactNo | String | Contact No | Mandatory |
| 9.14 | String | Mandatory | ||
| 9.15 | Baggage[] | Array | Baggage Info | Mandatory |
| 9.16 | MealDynamic[] | Array | Meal Info | Mandatory |
| 9.16.1 | AirlineCode | String | Airline Code | Mandatory |
| 9.16.2 | FlightNumber | String | Flight Number | Mandatory |
| 9.16.3 | WayType | Integer | Indicates the journey type for which the service applies.(1 = Onward, 2 = Return) | Mandatory |
| 9.16.4 | Code | String | Service or meal code associated with the flight | Mandatory |
| 9.16.5 | Description | String | Description of the service or meal | Optional |
| 9.16.6 | AirlineDescription | String | Airline specific description of the service, if provided | Optional |
| 9.16.7 | Quantity | Integer | Number of units of the service selected | Mandatory |
| 9.16.8 | Currency | String | Currency code in which the service price is provided | Mandatory |
| 9.16.9 | Price | Decimal | Price of the selected service or meal | Mandatory |
| 9.16.10 | Origin | String | Origin airport code for which the service is applicable | Mandatory |
| 9.16.11 | Destination | String | Destination airport code for which the service is applicable | Mandatory |
| 9.17 | IsLeadPax | Boolean | Represent the lead guest of the booking (Value - True/False) | Mandatory |
| 9.18 | Seat[] | Array | Fare | Mandatory |
| 9.18.1 | SeatNumber | String | Seat Number | Mandatory |
| 9.18.2 | SeatNumber | String | Seat number assigned or selected for the passenger | Mandatory |
| 9.18.3 | IsBooked | Boolean | Indicates whether the seat is already booked | Mandatory |
| 9.18.4 | IsLegroom | Boolean | Indicates whether the seat has extra legroom | Optional |
| 9.18.5 | IsAisle | Boolean | Indicates whether the seat is an aisle seat | Optional |
| 9.18.6 | Amount | Decimal | Price charged for the selected seat | Mandatory |
| 9.18.7 | Code | String | Unique seat selection code provided by the airline | Mandatory |
| 9.19 | Fare{} | Object | Fare Object | Mandatory |
| 9.19.8 | Currency | String | Currency | Mandatory |
| 9.19.9 | BaseFare | Decimal | Base fare | Mandatory |
| 9.19.10 | Tax | Decimal | Total Tax | Mandatory |
| 9.19.11 | YQTax | Decimal | Fuel surcharge | Mandatory |
| 9.19.12 | OtherCharges | Decimal | Other Charges | Mandatory |
| 9.19.13 | TransactionFee | Decimal | Transaction Fee | Mandatory |
| 9.19.14 | AdditionalTxnFeeOfrd | Decimal | Additional Transaction Fee Offered (It will always be zero) | Mandatory |
| 9.19.15 | AdditionalTxnFeePub | Decimal | Additional Transaction Fee Offered | Mandatory |
| 9.19.16 | AirTransFee | Decimal | Air trans fee | Mandatory |
Hold GDS Response
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | Error{} | Object | Error | Mandatory |
| 1.1 | ErrorCode | String | ErrorCode | Mandatory |
| 1.2 | ErrorMessage | String | Error Message | Mandatory |
| 2 | TraceId | String | Trace ID | Mandatory |
| 3 | ResponseStatus | String | Response Status | Mandatory |
| 4 | SrdvType | String | Simple result data version | Mandatory |
| 5 | Response{} | Object | Response | Mandatory |
| 5.1 | SrdvIndex | String | Simple result data version index | Mandatory |
| 5.2 | PNR | String | PNR number | Mandatory |
| 5.3 | BookingId | Integer | Unique booking id (if booking id is provided as 0,then you may call Get Booking Details method using Trace id or PNR with First Name and Last Name of the lead passenger) | Mandatory |
| 5.4 | SSRDenied | String | SSR Denied | Mandatory |
| 5.5 | SSRMessage | String | SSR Message | Optional |
| 5.6 | Status | String | Status [NotSet = 0, Successful = 1, Failed = 2, OtherFare = 3, OtherClass = 4, BookedOther = 5, NotConfirmed = 6] | Mandatory |
| 5.7 | IsPriceChanged | Boolean | Represents whether price has changed or not | Mandatory |
| 5.8 | IsTimeChanged | Boolean | Represents whether time has changed or not | Mandatory |
| 5.9 | FlightItinerary{} | Object | Fare of search result | Mandatory |
| 5.9.1 | BookingId | Integer | Unique booking iD | Mandatory |
| 5.9.2 | IsManual | String | Specifies if the itinerary is manually created or system generated. | Mandatory |
| 5.9.3 | PNR | String | PNR No | Mandatory |
| 5.9.4 | IsDomestic | Boolean | Search request is for domestic or international (Value – True or False) | Mandatory |
| 5.9.5 | Source | String | Airline source | Mandatory |
| 5.9.6 | Origin | String | Origin | Mandatory |
| 5.9.7 | Destination | String | Destination | Mandatory |
| 5.9.8 | AirlineCode | String | Airline Code | Mandatory |
| 5.9.9 | LastTicketDate | String | Last Ticket Date | Mandatory |
| 5.9.10 | ValidatingAirlineCode | String | Validating Airline Code | Mandatory |
| 5.9.11 | AirlineRemark | String | Airline Remark | Mandatory |
| 5.9.12 | IsLCC | Boolean | Is the result for LCC or Non LCC (Value – True or False) | Mandatory |
| 5.9.13 | NonRefundable | Boolean | Is the fare refundable or not (Value – True or False) | Mandatory |
| 5.9.14 | FareType | String | Fare Type | Mandatory |
| 5.9.15 | CreditNoteNo | String | Credit Note No | Mandatory |
| 5.9.16 | Fare{} | Object | Fare Details | Mandatory |
| 5.9.16.1 | Currency | String | Currency | Mandatory |
| 5.9.16.2 | BaseFare | Decimal | Base fare | Mandatory |
| 5.9.16.3 | Tax | Decimal | Total tax | Mandatory |
| 5.9.16.4 | YQTax | Decimal | Fuel Surcharge | Mandatory |
| 5.9.16.5 | AdditionalTxnFeeOfrd | Decimal | Additional Transaction Fee Offered (It will always be zero) | Mandatory |
| 5.9.16.6 | AdditionalTxnFeePub | Decimal | Additional Transaction Fee Published | Mandatory |
| 5.9.16.7 | PGCharge | Decimal | PG Charge | Mandatory |
| 5.9.16.8 | OtherCharges | Decimal | Other Charges | Mandatory |
| 5.9.16.9 | PublishedFare | Decimal | Published Fare | Mandatory |
| 5.9.16.10 | OfferedFare | Decimal | Offered Fare | Mandatory |
| 5.9.16.11 | CommissionEarned | Decimal | Agent Commission | Mandatory |
| 5.9.16.12 | TdsOnCommission | Decimal | TDS on the commission. | Mandatory |
| 5.9.16.13 | ServiceFee | Decimal | Service Fee | Mandatory |
| 5.9.16.14 | TotalBaggageCharges | Decimal | Total Baggage Charges | Mandatory |
| 5.9.16.15 | TotalMealCharges | Decimal | Total Meal Charges | Mandatory |
| 5.9.16.16 | TotalSeatCharges | Decimal | Total Seat Charges | Mandatory |
| 5.9.16.17 | TotalSpecialServiceCharges | Decimal | Total Special Service Charges | Mandatory |
| 5.9.17 | CreditNoteCreatedOn | Date Time | Credit Note Created On | Mandatory |
| 5.9.18 | Passenger[] | Array | Passenger | Mandatory |
| 5.9.18.1 | PaxId | String | Unique pax id | Mandatory |
| 5.9.18.2 | Title | String | Title | Mandatory |
| 5.9.18.3 | FirstName | String | First Name | Mandatory |
| 5.9.18.4 | LastName | String | LastName | Mandatory |
| 5.9.18.5 | PaxType | Integer | Pax Type | Mandatory |
| 5.9.18.6 | DateOfBirth | Date Time | Date Of Birth | Mandatory |
| 5.9.18.7 | Gender | String | Gender | Mandatory |
| 5.9.18.8 | PassportNo | String | Passport No | Optional |
| 5.9.18.9 | AddressLine1 | String | Address | Mandatory |
| 5.9.18.10 | City | String | City | Mandatory |
| 5.9.18.11 | CountryCode | String | Country Code | Mandatory |
| 5.9.18.12 | CountryName | String | Country Name | Mandatory |
| 5.9.18.13 | Nationality | String | Nationality | Mandatory |
| 5.9.18.14 | ContactNo | String | Contact No | Mandatory |
| 5.9.18.15 | String | Mandatory | ||
| 5.9.18.16 | IsLeadPax | Boolean | Represent the lead guest of the booking | Mandatory |
| 5.9.18.17 | FFAirlineCode | String | Frequent flyer airline | Optional |
| 5.9.18.18 | FFNumber | String | Frequent flyer number | Optional |
| 5.9.18.19 | Fare{} | Object | Fare | Mandatory |
| 5.9.18.19.1 | Currency | String | Currency | Mandatory |
| 5.9.18.19.2 | BaseFare | Decimal | Base fare | Mandatory |
| 5.9.18.19.3 | Tax | Decimal | Total Tax | Mandatory |
| 5.9.18.19.4 | YQTax | Decimal | Fuel surcharge | Mandatory |
| 5.9.18.19.5 | AdditionalTxnFeeOfrd | Decimal | Additional Transaction Fee Offered (It will always be zero) | Mandatory |
| 5.9.18.19.6 | AdditionalTxnFeePub | Decimal | Additional Transaction Fee Published | Mandatory |
| 5.9.18.19.7 | PGCharge | Decimal | PG Charge | Mandatory |
| 5.9.18.19.8 | OtherCharges | Decimal | Other Charges | Mandatory |
| 5.9.18.19.9 | PublishedFare | Decimal | Published Fare | Mandatory |
| 5.9.18.19.10 | OfferedFare | Decimal | Offered Fare | Mandatory |
| 5.9.18.19.11 | ServiceFee | Decimal | Service Fee | Mandatory |
| 5.9.18.19.12 | TotalBaggageCharges | String | Total Baggage Charges | Mandatory |
| 5.9.18.19.13 | TotalMealCharges | String | Total Meal Charges | Mandatory |
| 5.9.18.19.14 | TotalSeatCharges | String | Total Seat Charges | Mandatory |
| 5.9.18.19.15 | TotalSpecialServiceCharges | String | Total Special Service Charges | Mandatory |
| 5.9.19 | CancellationCharges | String | Cancellation Charges | Mandatory |
| 5.9.20 | Segments[] | array | Segments | Mandatory |
| 5.9.20.1 | Baggage | String | Baggage | Mandatory |
| 5.9.20.2 | CabinBaggage | String | Cabin Baggage | Mandatory |
| 5.9.20.3 | TripIndicator | String | Trip Indicator | Mandatory |
| 5.9.20.4 | SegmentIndicator | Integer | Segment indicator | Mandatory |
| 5.9.20.5 | DepTime | DateTime | Departure time | Mandatory |
| 5.9.20.6 | ArrTime | Time | Arrival time | Mandatory |
| 5.9.20.7 | Airline{} | Object | Airline | Mandatory |
| 5.9.20.7.1 | AirlineCode | String | Airline code | Mandatory |
| 5.9.20.7.2 | AirlineName | String | Airline name | Mandatory |
| 5.9.20.7.3 | FlightNumber | String | Flight Number | Mandatory |
| 5.9.20.7.4 | FareClass | String | FareClass | Mandatory |
| 5.9.20.7.5 | OperatingCarrier | String | OperatingCarrier | Mandatory |
| 5.9.20.8 | AirlinePNR | String | Airline PNR | Optional |
| 5.9.20.9 | AccumulatedDuration | Time | Accumulated Duration | Optional |
| 5.9.20.10 | Origin{} | Object | Origin Details | Mandatory |
| 5.9.20.10.1 | AirportCode | String | Airport Code | Mandatory |
| 5.9.20.10.2 | AirportName | String | Airport Name | Mandatory |
| 5.9.20.10.3 | Terminal | String | Terminal Number | Optional |
| 5.9.20.10.4 | CityCode | String | City code | Mandatory |
| 5.9.20.10.5 | CityName | String | City name | Mandatory |
| 5.9.20.10.6 | CountryCode | String | Country code | Mandatory |
| 5.9.20.10.7 | CountryName | String | Country name | Mandatory |
| 5.9.20.11 | Destination{} | Object | Destination Details | Mandatory |
| 5.9.20.11.1 | AirportCode | String | Airport Code | Mandatory |
| 5.9.20.11.2 | AirportName | String | Airport Name | Mandatory |
| 5.9.20.11.3 | Terminal | String | Terminal Number | Optional |
| 5.9.20.11.4 | CityCode | String | City code | Mandatory |
| 5.9.20.11.5 | CityName | String | City name | Mandatory |
| 5.9.20.11.6 | CountryCode | String | Country code | Mandatory |
| 5.9.20.11.7 | CountryName | String | Country name | Mandatory |
| 5.9.20.12 | Duration | Time | Duration | Optional |
| 5.9.20.13 | GroundTime | Time | Ground time | Optional |
| 5.9.20.14 | Mile | String | Miles | Optional |
| 5.9.20.15 | StopOver | String | Stop Over | Optional |
| 5.9.20.16 | StopPoint | String | Stopover point | Optional |
| 5.9.20.17 | StopPointArrivalTime | Date Time | Stopover arrival time | Optional |
| 5.9.20.18 | StopPointDepartureTime | Date Time | Stopover departure time | Optional |
| 5.9.20.19 | Craft | String | Craft | Optional |
| 5.9.20.20 | Remark | String | Remark | Optional |
| 5.9.20.21 | IsETicketEligible | Boolean | Is E-Ticket eligible | Mandatory |
| 5.9.20.22 | FlightStatus | String | Flight status | Mandatory |
| 5.9.20.23 | Status | String | Status | Mandatory |
| 5.9.21 | FareRules[] | Array | Fare Rules | Mandatory |
| 5.9.21.1 | Origin | String | Origin | Mandatory |
| 5.9.21.2 | Destination | String | Destination | Mandatory |
| 5.9.21.3 | Airline | String | Airline | Mandatory |
| 5.9.21.4 | FareBasisCode | String | Fare Basis Code | Mandatory |
| 5.9.21.5 | FareRuleDetail | String | Fare Rule Detail | Mandatory |
| 5.9.21.6 | FareRestriction | String | Fare Restriction | Mandatory |