menu

GetHotelResult

  • User will requests for De-dupe results from TBO Hotel API by sending the “IsTBOMapped” node as true in search request.
  • The hotel rate received for de-dupe results in search response result will be the Minimum rate across all suppliers.
  • Hotel static data will be available for all properties where “IsTBOMapped” is set to true in search response.
  • In Search response for results where "IsTBOMapped" is true, the hotel information like HotelName, StarRating, HotelDescription, HotelPolicy etc need to refer from static data response for that particular Hotel.
  • All De-dupe results in search response will have SupplierHotelCodes array which consists of CategoryId and CategoryIndex nodes.
  • SupplierHotelCodes array length will determine the number of suppliers from which hotel inventory was received.
  • To get the location wise search, three extra nodes will be passed in the search request(i.e. radius, latitude-longitude,"IsTBOMapped"=true) and then it will show the location wise results.Longitude and Latitude will be fetch from the city wise static data response, Radius should be pass uptop 1km to 20km.
  • Count of SupplierHotelCodes array length determines the no. of suppliers from which the property results have been received.
  • User has the option to choose any other suppliers result by using the CategoryId in further methods.
GetHotelResult Request
Level Element Format Comments Mandatory/ Optional
1 EndUserIp String IP Address of the end user Mandatory
2 TokenId String Token ID Mandatory (Token Id to be echoed back from Authenticate response)
3 CheckInDate Date Start Date of the requested Stay Mandatory Format: (dd/mm/yyyy)
4 NoOfNights Integer Nights of Stay Mandatory (Minimum value should be 1)
5 CountryCode String ISO Country Code of Destination (Ex. India = IN, Great Britain = GB) Mandatory
6 CityId Integer Destination City Id Mandatory
7 IsTBOMapped String "True" (For Faster Results and No Duplicate Inventories) Mandatory
8 Radius String NearBy Searches Mandatory
9 Latitude String Latitude information of the hotel Mandatory(For Location wise Search)
10 Longitude String Longitude information of the hotel Mandatory(For Location wise Search)
11 ResultCount Integer For restricting no. of Hotel results in search response Optional (Reserved for future use)
12 PreferredCurrency String Preferred Currency in which client is expecting price Mandatory
13 GuestNationality String ISO Country Code (Ex. India = IN, Great Britain = GB) Mandatory
14 NoOfRooms Integer Requested number of rooms Mandatory
15 RoomGuests [ ] Array Number and type of guests in a room Mandatory
15.1 NoOfAdults Integer Number of adults in the room Mandatory
15.2 NoOfChild Integer Number of children in the room Mandatory (Minimum value should be 0)
15.3 ChildAge [ ] Integer Array Child age Mandatory * (only when ChildCount is more than 0)
16 HotelId Integer TBOHotelCode Optional * (This can be fetched from Static data response for the mapped hotels)
Filters - Can be used to refine search
17 MaxRating Integer Filter by Star Rating Mandatory (To be used only in combination with MinRating. MaxRating should be greater than or equal to MinRating. Possible values can be 0 – 5)
18 MinRating Integer Filter by Star Rating Mandatory (Can be used only in combination with MinRating. MinRating should be less than or equal to MaxRating. Possible values can be 0 – 5).
19 ReviewScore Decimal Filter by Review Score Optional (Reserved for future use)
20 IsNearBySearchAllowed Boolean To allow nearby search Optional (Reserved for future use)
GetHotelResult Response
Level Element Format Comments Mandatory/ Optional
1 TraceId String Trace ID Mandatory (Trace Id to be echoed back in further requests)
2 CheckInDate Date Start Date of the requested Stay Mandatory Format: (dd/mm/yyyy)
3 CheckOutDate Date End Date of the requested Stay Mandatory Format: (dd/mm/yyyy)
4 CityId Integer Destination City Id Mandatory
5 ResultCount Integer For restricting no. of Hotel results in search response Optional (Reserved for future use)
6 PreferredCurrency String Preferred Currency in which client is expecting price Mandatory
7 NoOfRooms Integer Requested number of Mandatory
rooms
8 RoomGuests [ ] Array of element Mandatory
8.1 NoOfAdults Integer Number of adults in the room Mandatory
8.2 NoOfChild Integer Number of children in the room Mandatory (Minimum value should be 0)
8.3 ChildAge Integer Array Child age Mandatory * (only when ChildCount is more than 0)
8.4 HotelResults [ ] Array of element Array of the unique hotel results Mandatory (Can be blank in case no hotels found for requested City)
8.5 ResultIndex Integer Result Index Mandatory
8.6 HotelCode String Unique hotel code Mandatory (HotelCode to be echoed back in further requests)
8.7 HotelName String Unique hotel Name Mandatory
8.8 HotelCategory String Hotel Category Optional
8.9 StarRating Enumeration Star Rating of the hotel Mandatory - StarRating All = 0, OneStar = 1, TwoStar = 2, ThreeStar = 3, FourStar = 4, FiveStar = 5
8.10 HotelDescription String Description of the hotel Mandatory
8.11 HotelPromotion String Promotional details of the hotel Optional
8.12 HotelPolicy String Hotel policy details Optional
8.13 HotelPicture String Hotel Image URL Mandatory
8.14 HotelAddress String Address of the hotel Mandatory
8.15 HotelContactNo String Contact Number of the hotel Optional
8.16 HotelMap String Direction Map of the hotel Optional
8.17 Latitude String Latitude information of the hotel Optional
8.18 Longitude String Longitude information of the hotel Optional
8.19 HotelLocation String Hotel Location Optional
8.20 Price [ ] Array Price Array Mandatory (Minimum price of the hotel rooms)
8.20.1 CurrencyCode String Currency in which minimum hotel price is returned Mandatory
8.20.2 RoomPrice Decimal Price of the room Mandatory
8.20.3 Tax Decimal Tax applicable for the room Optional
8.20.4 ExtraGuestCharge Decimal Extra Guest Charges applicable for the room Optional
8.20.5 ChildCharge Decimal Child Charges applicable for the room Optional
8.20.6 OtherCharges Decimal Other Charges applicable for the room Optional
8.20.7 Discount Decimal Discount applicable for the room Optional (Currently not in use)
8.20.8 PublishedPrice Decimal Published Price of the room Mandatory (This price would be different only if Room Price is on PUBLISHED. In case of NET, Published Price would be same as Offered Price)
8.20.9 PublishedPriceRounde dOff Integer Published Price (rounded off) of the room Mandatory (This price is for display purpose only)
8.20.10 OfferedPrice Decimal Offered Price of the room Mandatory
8.20.11 OfferedPriceRoundedO ff Integer Offered Price (rounded off) of the room Mandatory (This price is for display purpose only)
8.20.12 AgentCommission Decimal Commission applicable on the Room Price Optional (TBO will part this amount if Room Price is on Published)
8.20.13 AgentMarkUp Decimal Agent Mark Up applicable on the Room Price Optional (Agent will earn this amount if Hotel markup is set from backend)
8.20.14 ServiceTax Decimal Service tax applicable for the room Optional
8.20.15 TDS Decimal TDS applicable on Commission Earned Optional (This would be deducted only when commission is parted to the agent)
9 TripAdvisor [ ]
9.1 Rating String Trip Advisor Rating Optional (This would come only when trip advisor rating is available for the particular hotel)
9.2 ReviewURL String Trip Advisor Review URL Optional (This would come only when trip advisor rating/ url is available for the particular hotel)
10 ResponseStatus Enumeration Response status Mandatory NotSet = 0, Successfull = 1, Failed = 2, InValidRequest = 3, InValidSession = 4, InValidCredentials = 5
11 Error Mandatory
11.1 ErrorCode Integer Code corresponding to the Error Mandatory
11.2 ErrorMessage String Contains error message Mandatory (Will contain error description corresponding to ErrorCode. Error Message would be blank in case ErrorCode=0)
12 IsTBOMapped String "True" (For Faster Results and No Duplicate Inventories) Mandatory
13 SupplierHotelCodes Array of element Array of CategoryId & CategoryIndex Mandatory
14 CategoryId String Unique Supplier RatePlan Mandatory
15 CategoryIndex String Unique Supplier ResultIndex Mandatory
16 SupplierPrice String Mandatory