Level
|
Element
|
Format
|
Comments
|
Mandatory/ Optional
|
1
|
AvailabilityType
|
String
|
Availability Type
will be received as Available/Confirm.
|
Mandatory
(Possible Values can be 'Available' or 'Confirm'.
If 'available', the user may either choose not to book the property and go for an alternate property or book the inventory but get it re- confirmed from agent/ TBO Backoffice as there is a possibility of the property being sold out.
If 'confirm', the user may proceed to book the property without requiring to reconfirm from agent/ TBO Backoffice.)
|
2
|
IsPriceChanged
|
Boolean
|
Represent if price is changed or not
|
Mandatory
(Would be set true, if there is a price change.
Would be set as false, if no price change)
|
3
|
IsCancellationPolicyChang ed
|
Boolean
|
Represent if cancellation policy is changed or not
|
Mandatory
(Would be set true, if there is a change in cancellation policy.
Would be set as false, if no change in cancellation policy)
|
4
|
HotelNorms
|
String
|
Hotel Norms
|
Optional
|
5
|
HotelRoomDetails
|
Array
|
Array of hotel room details
|
Mandatory
|
5.1
|
RequireAllPaxDetails
|
Boolean
|
Represents if passenger detail is required all guests or only for lead guest. If true, then details would be required for all
guests.
|
Mandatory
|
5.2
|
RoomIndex
|
Integer
|
Index of the room (referenced in OptionsForBooking)
|
Mandatory
|
5.3
|
RatePlanCode
|
String
|
Rate plan code associated with room
|
Mandatory
|
5.4
|
RatePlanName
|
String
|
Name of the Rate plan associated with room
|
Optional
|
5.5
|
RoomTypeCode
|
String
|
Room Type Code
|
Mandatory
|
5.6
|
RoomTypeName
|
String
|
Room Type Name
|
Optional
|
5.7
|
InfoSource
|
String
|
Shows the format to select possible multiple room combinations to book
|
Mandatory
Possible values can be FixedCombination, OpenCombination.
|
5.8
|
SequenceNo
|
String
|
Sequence Number of the Room
|
Optional
(Not Applicable for API Customers)
|
5.9
|
DayRates
|
Array
|
Per day rate breakup of the room
|
Mandatory
|
5.9.1
|
Amount
|
Decimal
|
Per day price of the room
|
Mandatory
|
5.9.2
|
Date
|
Date
|
Date for which day rate is applicable
|
Mandatory
Format: (dd/mm/yyyy)
|
5.10
|
Price
|
Array
|
Price detail of the room
|
Mandatory
|
5.10.1
|
CurrencyCode
|
String
|
Currency in which minimum hotel price is returned
|
Mandatory
|
5.10.2
|
RoomPrice
|
Decimal
|
Price of the room
|
Mandatory
|
5.10.3
|
Tax
|
Decimal
|
Tax applicable for the room
|
Optional
|
5.10.4
|
ExtraGuestCharge
|
Decimal
|
Extra Guest Charges applicable for the room
|
Optional
|
5.10.5
|
ChildCharge
|
Decimal
|
Child Charges applicable for the room
|
Optional
|
5.10.6
|
OtherCharges
|
Decimal
|
Other Charges applicable for the room
|
Optional
|
5.10.7
|
Discount
|
Decimal
|
Discount applicable for the room
|
Optional
(Currently not in use)
|
5.10.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)
|
5.10.9
|
PublishedPriceRoundedOf f
|
Integer
|
Published Price (rounded off) of the room
|
Mandatory
(This price is for display purpose only)
|
5.10.10
|
OfferedPrice
|
Decimal
|
Offered Price of the
room
|
Mandatory
|
5.10.11
|
OfferedPriceRoundedOff
|
Integer
|
Offered Price (rounded off) of the room
|
Mandatory
(This price is for display purpose only)
|
5.10.12
|
AgentCommission
|
Decimal
|
Commission applicable on the Room Price
|
Optional
(TBO will part this amount if Room Price is on Published)
|
5.10.13
|
AgentMarkUp
|
Decimal
|
Agent Mark Up applicable on the Room Price
|
Optional
(Agent will earn this amount if Hotel markup is set from backend)
|
5.10.14
|
TDS
|
Decimal
|
TDS applicable on Commission Earned
|
Optional
(This would be deducted only when commission is parted to the agent)
|
5.11
|
RoomPromotion
|
String
|
Room promotion applicable for the room
|
Optional
|
5.12
|
Amenities
|
StringList
|
List of room amenities
|
Optional
|
5.13
|
SmokingPreference
|
Enumeration
|
Smoking Preference associated with room
|
Optional- SmokingPreference NoPreference = 0,Smoking = 1,NonSmoking = 2,Either = 3
|
5.14
|
BedTypes [ ]
|
Array
|
Array of bed types
|
Optional
|
5.14.1
|
BedTypeCode
|
Integer
|
Bed type code
|
Optional
|
5.14.2
|
BedTypeDescription
|
String
|
Bed type description
|
Optional
|
5.15
|
Supplements
|
StringList
|
List of supplements
|
Optional
|
5.16
|
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)
|
5.17
|
CancellationPolicies
|
Array
|
Array of cancellation policies
|
Mandatory
|
5.17.1
|
Charge
|
Decimal
|
Cancellation charge
|
Mandatory
(Contains amount in case of Amount, Percentage value in case of Percentage, No of nights in case of Night)
|
5.17.2
|
ChargeType
|
Enumeration
|
Cancellation charge type
|
Mandatory
- CancellationPolicies
- ChargeType
Amount = 1,
Percentage = 2,
Nights = 3
|
5.17.3
|
BaseCurrency
|
String
|
Base currency of Cancellation charge
|
Mandatory
(Default currency would be INR)
|
5.17.4
|
FromDate
|
Date
|
Date from which charges will apply
|
Mandatory
Format: (dd/mm/yyyy)
|
5.17.5
|
ToDate
|
Date
|
Date up to which charges will apply
|
Mandatory
Format: (dd/mm/yyyy)
|
5.18
|
CancellationPolicy
|
String
|
Cancellation policy in text format
|
Mandatory
(Format: Text)
|
5.19
|
SupplierSpecificData
|
String
|
Supplier Specific Data
|
Optional
|
6
|
ResponseStatus
|
Enumeration
|
Response status
|
Mandatory
|
7
|
Error
|
|
|
Mandatory
|
7.1
|
ErrorCode
|
Integer
|
Code corresponding to the Error
|
Mandatory
|
7.2
|
ErrorMessage
|
String
|
Contains error
message
|
Mandatory
|
8
|
IsPackageDetailsMandatory
|
Boolean
|
If "IsPackageDetailsMandatory" is true then "IsPackageFare" will always be received true.
|
Optional
|
9
|
IsPackageFare
|
Boolean
|
if "IsPackageFare" is true then "IsPackageDetailsMandatory" can be true or false.
|
Optional
|
10
|
IsPerStay
|
Boolean
|
If you are receiving "IsPerStay" node true in RoomDetails response then you will not receive array of DateRate[] within Roomdetails, Block and GetBookingDetails API response.
|
Optional
|