Get Hotel Room Response

Hotel Room Response

Element
Format
Meaning
Mandatory/Optional
UserIp
String
IP Address of the end user
Mandatory
Search_Token
String
Search Token ID
Mandatory
Currency
String
Currency Value (INR)
Mandatory
Error
[]
ErrorCode
Integer
Error code
Mandatory
ErrorMessage
String
In case of hotel search, if any issue arises, it shows an error message. Otherwise Null.
Mandatory
Currency
String
Preferred currency in which client is expecting price
Mandatory
Result
[]
IsUnderCancellationAl lowed
Boolean
Represents if under cancellation booking is allowed for agency or not. If allowed, then the agency can make under cancellation booking. Otherwise not.
Mandatory
IsPolicyPerStay
Boolean
Represents if the cancellation policy is per stay wise or per room wise. If true, then the cancellation policy is per stay.
Mandatory
HotelRoomDetails
[]
ChildCount
Integer
No. of Child
Opptional
RequireAllPaxDetails
Boolean
Represents if passenger detail is required for all guests or only for lead guest.
Mandatory (If true, then details would be required for all guests. If false, then detail would be required only for the lead guest of each room. However, even if “RequireAllPaxDetails” is set as false, the HotelPassenger array structure is required for all guests.
RoomId
Integer
Index of the room (referenced in OptionsForBooking)
Mandatory
RoomStatus
RoomIndex
Integer
Index of the room (referenced in OptionsForBooking)
Mandatory
RoomTypeCode
String
Room Type Code
Mandatory
RoomTypeName
String
Room Type Name
Optional
RatePlanCode
String
Rate plan code associated with room
Mandatory
RatePlan
String
Name of the Rate plan associated with room
Optional
InfoSource
String
Shows the format to select possible multiple room combinations to book
Mandatory Possible values can be FixedCombination, OpenCombination.
SequenceNo
String
Sequence Number of the Room
Optional (Not Applicable for API Customers)
OtherCharges
Decimal
Other Charges applicable for the room
Optional
DayRates
Array
Per day rate breakup of the room
Optional
Amount
Decimal
Per day price of the room
Mandatory
Date
Date
Mandatory Format: (dd/mm/yyyy)
Optional
Price
Array
Price detail of the room
Mandatory
CurrencyCode
String
Currency in which minimum hotel price is returned
Mandatory
RoomPrice
Decimal
Price of the room
Mandatory
Tax
Decimal
Tax applicable for the room
Optional
Longitude
String
Longitude information of the hotel
Optional
ExtraGuestCharge
Decimal
Extra Guest Charges applicable for the room
Optional
ChildCharge
Decimal
Child Charges applicable for the room
Optional
OtherCharges
Decimal
Other Charges applicable for the room
Optional
Discount
Decimal
Discount applicable for the room
Optional
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)
PublishedPriceRounde dOff
Integer
Published Price (rounded off) of the room
Mandatory (This price is for display purpose only)
OfferedPrice
Decimal
Offered Price of the room
Mandatory
OfferedPriceRoundedO ff
Integer
Offered Price (rounded off) of the room
Mandatory (This price is for display purpose only)
AgentCommission
Decimal
Commission applicable on the Room Price
Optional
AgentMarkUp
Decimal
Agent Mark Up applicable on the Room Price
Optional (Agent will earn this amount if Hotel markup is set from backend)
ServiceTax
Decimal
Service tax applicable for the room
Mandatory
TDS
Decimal
TDS applicable on Commission Earned
Optional (This would be deducted only when commission is parted to the agent)
ServiceCharge
Decimal
Service Charge
Optional
RoomPromotion
String
Room promotion applicable for the room
Optional
Amenities
StringList
List of room amenities
Optional
SmokingPreference
Enumerati on
Smoking Preference associated with room
SmokingPreference NoPreference = 0, Smoking = 1, NonSmoking = 2, Either = 3
BedTypes [ ]
Array
Array of bed types
Optional
HotelSupplements
String
List of supplements
Optional
AgentCommission
Decimal
Commission applicable on the Room Price
Optional
LastCancellationDate
Date
Last Cancellation Date
Mandatory (No cancellation charge will be applied up to this date. If the date is less than book date then cancellation charge will be applicable as per policy) Format: (dd/mm/yyyy)
CancellationPolicies
Array
Array of cancellation policies
Mandatory
Charge
Charge
Charge
Mandatory (Contains amount in case of Amount, Percentage value in case of Percentage, No of nights in case of Night)
ChargeType
Enumerati on
Cancellation charge type
Mandatory - CancellationPolicies - ChargeType Amount = 1, Percentage = 2, Nights = 3
Currency
String
Base currency of Cancellation charge
Mandatory (Default currency would be INR)
FromDate
Date
Date from which charges will apply
Mandatory Format: (dd/mm/yyyy)
ToDate
Date
Date up to which charges will apply
Mandatory Format: (dd/mm/yyyy)
CancellationPolicy
String
Cancellation policy in text format
Mandatory (Format: Text)
RoomCombinations
Array
Array of Room options available to book
Mandatory
InfoSource
String
Shows the format to select possible multiple room combinations to book
Mandatory Possible values can be FixedCombination, OpenCombination.
RoomCombination
Array
Possible combinations of
Mandatory
RoomIndex
IntegerArray
Index of rooms which can be combined
Mandatory