HOTEL SEARCH
This method is used to search hotels available for booking in a specific city within a date range. This method checks:
1. General availability of hotels in a specific city.
2. Availability based on star rating of hotels (5 star or more, 4 star or more, etc).
3. Availability based on Preferred Hotel. If preferred hotel is not found then all hotels in same
city will be in response.
1. 'RoomGuest' will repeat for multiple rooms search.
2. Child age(s) are compulsory when search request includes child.
3. Hotel price might vary for same Search Request with different GuestNationality.
Service URL (REST) to be used:
Hotel Search Request
Level | Element | Format | Comments | Mandatory |
---|---|---|---|---|
1 | BookingMode | Integer | Mode of booking | Mandatory |
2 | CheckInDate | Date | Start Date of the requested Stay (Format: -YYYY-MM-DD) | Mandatory |
3 | NoOfNights | Integer | Nights of Stay (Minimum value should be 1) | Mandatory |
4 | CountryCode | String | ISO Country Code of Destination (Ex. India = IN, Great Britain = GB) | Mandatory |
5 | CityId | Integer | Destination City Id | Mandatory |
6 | ResultCount | Integer | For restricting no. of Hotel results in search response (Reserved for future use) | Optional |
7 | PreferredCurrency | String | Preferred Currency in which client is expecting price | Mandatory |
8 | GuestNationality | String | ISO Country Code (Ex. India = IN, Great Britain = GB) | Mandatory |
9 | NoOfRooms | Integer | Requested number of rooms | Mandatory |
10 | RoomGuests[] | Array | Number and type of guests in a room | Mandatory |
10.1 | NoOfAdults | Integer | Number of adults in the room | Mandatory |
10.2 | NoOfChild | Integer | Number of children in the room | Mandatory |
10.3 | ChildAge[] | Integer Array | Child Age (Only when Child Count ismore than 0) | Mandatory |
11 | PreferredHotel | String | Filter / Search by Hotel Name | Mandatory |
12 | MaxRating | Integer | Filter by Star Rating (To be used only in combination with MinRating. MinRating should be greater than or equal to MinRating. Possible values can be 0 – 5). | Mandatory |
13 | MinRating | Integer | Filter by Star Rating (Can be used only in combination with MinRating. MinRating should be less than or equal to MaxRating. Possible values can be 0 – 5). | Mandatory |
14 | ReviewScore | Decimal | Filter by Review Score (Reserved for future use) | Optional |
15 | IsNearBySearchAllowed | Boolean | To allow nearby search (Reserved for future use) | Optional |
16 | EndUserIp | String | IP Address of the end user | Mandatory |
17 | ClientId | String | Client ID provided to the agency at registration | Mandatory |
18 | UserName | String | Client ID provided to the agency at registration | Mandatory |
19 | Password | String | Client ID provided to the agency at registration | Mandatory |
Level | Element | Format | Comments | Mandatory |
---|---|---|---|---|
1 | Error[] | Array | Error | Mandatory |
1.1 | ErrorCode | String | Error Code | Mandatory |
1.2 | ErrorMessage | String | Error Message | Mandatory |
2 | TraceId | String | Trace ID | Mandatory |
3 | SrdvType | String | Simple result data version | Mandatory |
4 | CityId | Integer | Destination City Id | Mandatory |
5 | Remarks | String | Remarks | Mandatory |
6 | CheckInDate | Date | Start Date of the requested Stay Format: (YYYY-MM-DD) | Mandatory |
7 | CheckOutDate | Date | End Date of the requested Stay Format: (YYYY-MM-DD) | Mandatory |
8 | PreferredCurrency | String | Preferred Currency in which client is expecting price | Mandatory |
9 | NoOfRooms | Integer | Requested number of rooms | Mandatory |
9.1 | NoOfAdults | Integer | Number of adults in the room | Mandatory |
9.2 | NoOfChild | Integer | Number of children in the room (Minimum value should be 0) | Mandatory |
9.3 | ChildAge[] | Integer Array | Child Age (only when Child Count is more than 0) | Mandatory |
10 | Results[] | Array | Array of Result | Mandatory |
10.1 | SrdvIndex | String | Simple result data | Mandatory |
10.2 | ResultIndex | Integer | ResultIndex | Mandatory |
10.3 | HotelCode | String | Unique hotel code (Hotel Code to be echoed back in further requests) | Mandatory |
10.4 | HotelName | String | Unique hotel Name | Mandatory |
10.5 | HotelCategory | String | Hotel Category | Optional |
10.6 | StarRating | Enumeration | Star Rating of the hotel – StarRating-All = 0, OneStar = 1, TwoStar = 2, ThreeStar = 3, FourStar = 4, FiveStar = 5 | Mandatory |
10.7 | HotelDescription | String | Description of the hotel | Mandatory |
10.8 | HotelPromotion | String | Promotional details of the hotel | Optional |
10.9 | HotelPolicy | String | Hotel Policy Details | Mandatory |
10.10 | HotelPicture | String | Hotel Image URL | Mandatory |
10.11 | HotelAddress | String | Published Fare | Mandatory |
10.12 | HotelContactNo | String | Contact Number of hotel | Optional |
10.13 | HotelMap | String | Direction Map of the hotel | Optional |
10.14 | Latitude | String | Latitude in Formation of the hotel | Optional |
10.15 | Longitude | String | Longitude in Formation ofthe hotel | Optional |
10.16 | HotelLocation | String | Hotel Location | Optional |
10.17 | SupplierPrice | String | Supplier Price | Optional |
10.18 | Price[] | Array | Price Array (Minimum price of the hotel rooms) | Mandatory |
10.18.1 | CurrencyCode | String | Currency in which minimum hotel price is returned | Mandatory |
10.18.2 | RoomPrice | Decimal | Price of the room | Mandatory |
10.18.3 | Tax | Decimal | Tax applicable for the room | Optional |
10.18.4 | ExtraGuestCharge | Decimal | Extra Guest Charges applicable for the room | Optional |
10.18.5 | ChildCharge | Decimal | Child Charges applicable for the room | Optional |
10.18.6 | OtherCharges | Decimal | Other Charges applicable for the room | Optional |
10.18.7 | Discount | Decimal | Discount applicable for the room (Currently not in use) | Mandatory |
10.18.8 | PublishedPrice | Decimal | Published Price of the room (This price would be different only if Room Price is on PUBLISHED. In case of NET, Published Price would be same as Offered Price) | Mandatory |
10.18.9 | PublishedPriceRoundedOff | Integer | Published Price (rounded off) of the room (This price is for display purpose only) | Mandatory |
10.18.10 | OfferedPrice | Decimal | Offered Price of the room | Mandatory |
10.18.11 | OfferedPriceRoundedOff | Integer | Offered Price (rounded off) of the room (This price is for display purpose only) | Mandatory |
10.18.12 | ServiceTax | Decimal | TDS applicable on Commission Earned (This would be deducted only when commission is parted to the agent) | Mandatory |
10.18.13 | TDS | Decimal | TDS applicable on Commission Earned (This would be deducted only when commission is parted to the agent) |
Mandatory |
10.18.14 | ServiceCharge | Decimal | Service Charge | Optional |
10.18.15 | TotalGSTAmount | Decimal | Total GST Amount | Optional |
10.18.16 | GST[] | Array | Array of GST | Optional |
10.18.16.1 | CGSTAmount | Decimal | CGST Amount | Optional |
10.18.16.2 | CGSTRate | Decimal | CGST Rate | Optional |
10.18.16.3 | CessAmount | Decimal | Cess Amount | Optional |
10.18.16.4 | CessRate | Decimal | Cess Rate | Optional |
10.18.16.5 | IGSTAmount | Decimal | IGST Amount | Optional |
10.18.16.6 | IGSTRate | Decimal | IGST Rate | Optional |
10.18.16.7 | SGSTAmount | Decimal | SGST Amount | Optional |
10.18.16.8 | SGSTRate | Decimal | SGST Rate | Optional |
10.18.16.9 | TaxableAmount | Decimal | TaxableAmount | Optional |
10.19 | Facilities[] | Array | Facilities Array | Mandatory |
10.19.1 | FacilitiesNames[] | Array | FacilitiesNames Array | Mandatory |
10.19.2 | RoomPrice | String | RoomPrice | Mandatory |
10.20 | Rooms[] | Array | Rooms Array | Mandatory |
10.20.1 | Cateogry | String | Rooms Cateogry | Mandatory |