Get Booking Detail Response

Get Booking Detail 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
Integer
Result
Mandatory
VoucherStatus
Boolean
Voucher Status
Mandatory true - Booking is vouchered false - Booking is not Vouchered
ResponseStatus
Enumerati on
Response status
Mandatory NotSet = 0, Successfull = 1, Failed = 2, InValidRequest = 3, InValidSession = 4, InValidCredentials = 5
Status
Enumerati on
Booking status
Mandatory Possible values can be 0 – BookFailed, 1 - Confirmed, 3 – VerifyPrice, 6 – Cancelled
HotelBookingStatus
String
Booking status description
Mandatory Possible values can be – BookFailed, Confirmed, VerifyPrice, Cancelled
InvoiceNumber
String
Invoice Number
Mandatory
ConfirmationNo
String
Unique confirmation number of the successful booking
Mandatory
BookingRefNo
String
Booking Reference Number
Mandatory
BookingId
Integer
Unique booking id of the successful booking
Mandatory
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 there is no price change)
IsCancellationPolicyC hanged
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 there is no change in cancellation policy.)
HotelRoomsDetails
Object
Hotel Room Details
AdultCount
Integer
Number of adults in the room
Mandatory
ChildCount
Integer
Number of child in the room
Mandatory * (Only if child is present
HotelPassenger
[]
Array of guest details for the particular room as requested in hotel search
Mandatory
Age
String
Age of the guest
Optional
BookingId
Integer
Unique booking id of the successful booking
Mandatory
Email
String
Email Id of the guest
Optional
FirstName
String
First name of the guest
Mandatory (Min 2 chars, Max 50 chars and no special character)
MiddleName
String
Middle name of the guest
Optional
LastName
String
Last name of the guest
Mandatory (Min 2 chars, Max 50 chars and no special character)
MiddleName
String
MiddleName of the guest
Optional
PassportExpDate
Date
Passport Expiry Date
Optional(provide in minimum date time format “0001-01- 01T00:00:00:00” )
PassportIssueDate
Date
Passport Issue Date
Optional(provide in minimum date time format “0001-01- 01T00:00:00:00” )
PassportNo
String
Passport No
Optional
PaxType
Enumeratio n
Guest Type
Mandatory - HotelPassenger - PaxType Adult = 1, Child = 2
Phoneno
String
Phone number
Optional
Title
String
Title of the guest
Mandatory Possible values can be Mr, Mrs, Miss, Ms
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 is required
only for lead guest of each room. However, even if “RequireAllPaxDetail s” 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
RoomTypeCode
String
Room Type Code
Mandatory
RatePlanCode
String
Rate plan code associated with room
Mandatory
RatePlan
String
Name of the Rate plan associated with room
Optional
DayRates
Array
Per day rate breakup of the room
Mandatory
Amount
Decimal
Per day price of the room
Mandatory
Date
Date
Date for which day rate is applicable
Mandatory Format: (dd/mm/yyyy)
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
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
IntePublished Price (rounded off) of the roomger
Mandatory (This price is for display purpose only)
OfferedPrice
Decimal
Offered Price of the room
Mandatory
OfferedPriceRounded Off
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
Enumeration
Smoking Preference associated with room
Optional - SmokingPreference NoPreference = 0, Smoking = 1, NonSmoking = 2, Either = 3
BedTypes [ ]
Array
Array of bed types
Optional
HotelSupplements
String
List of supplements
Optional - SmokingPreference NoPreference = 0, Smoking = 1, NonSmoking = 2, Either = 3
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
Decimal
Cancellation charge
Mandatory (Contains amount in case of Amount, Percentage value in case of Percentage, No of nights in case of Night)
ChargeType
Enumeration
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)/div>
FromDate
Date
Date from which charges will apply
Mandatory Format: (dd/mm/yyyy)
ToDate
Date
Date from which charges will apply
Mandatory Format: (dd/mm/yyyy)
CancellationPolicy
String
Cancellation policy in text format
Mandatory (Format: Text)
HotelPolicyDetail
String
Hotel Policy Details
Optional
InvoiceCreatedOn
Date Time
Invoice Creation Date
Mandatory
InvoiceNo
String
Invoice Number
Mandatory
HotelConfirmationNo
Date
Hotel Confirmation Number
Optional
HotelName
String
Unique Hotel Name
Mandatory
StarRating
Enumeratio n
Star Rating of the hotel
Mandatory - StarRating All = 0, OneStar = 1, TwoStar = 2, ThreeStar = 3, FourStar = 4, FiveStar = 5
AddressLine1
String
Address
Mandatory
AddressLine2
String
Address
Mandatory
AddressLine1
String
Address
Optional
StarRating
Enumeration
Star Rating of the hotel
Mandatory - StarRating All = 0, OneStar = 1, TwoStar = 2, ThreeStar = 3, FourStar = 4, FiveStar = 5
HotelPolicyDetail
String
Hotel Policy Details
Optional
CountryCode
String
ISO Country code of destination (Ex. India = IN)
Mandatory
AddressLine1
String
Address
Mandatory
Latitude
String
Latitude inFormation of the hotel
Optional
Longitude
String
Longitude inFormation of the hotel
Optional
City
CheckInDate
Date
Start Date of the requested
Mandatory Format: (dd/mm/yy)
Mandatory Format: (dd/mm/yy)
Date
Checkout Date
Mandatory Format: (dd/mm/yy)
NoOfRooms
Integer
Requested Number of Rooms
Mandatory
BookingDate
Date
Date of Booking
Mandatory Format: (dd/mm/yyyy)
SpecialRequest
String
Reserved for future use
Optional (Reserved for future use)
IsDomestic
Boolean
Is Domestic
Mandatory (Will be set true if domestic city)