Level
|
Element
|
Format
|
Comments
|
Mandatory/ Optional
|
1
|
VoucherStatus
|
Boolean
|
Voucher Status
|
Mandatory
true - Booking is vouchered
false - Booking is not Vouchered
|
2
|
Status
|
Enumeration
|
Booking status
|
Mandatory
Possible values can be 0 – BookFailed,
1 - Confirmed,
3 – VerifyPrice,
6 – Cancelled
|
3
|
HotelBookingStatus
|
String
|
Booking status description
|
Mandatory
Possible values can be – BookFailed, Confirmed, VerifyPrice, Cancelled
|
4
|
TraceId
|
String
|
Trace Id
|
Mandatory
|
5
|
BookingId
|
Integer
|
Unique Booking ID
|
Mandatory
|
6
|
ConfirmationNo
|
String
|
Unique Confirmation Number
|
Mandatory
|
7
|
BookingReferenceNo
|
String
|
Booking Reference Number
|
Optional
|
8
|
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)
|
9
|
IsCancellationPolicyChanged
|
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.)
|
10
|
HotelRoomsDetails
|
Object
|
Hotel Room Details
|
|
10.1
|
AdultCount
|
Integer
|
Number of adults in
the room
|
Mandatory
|
10.2
|
ChildCount
|
Integer
|
Number of child in the room
|
Mandatory *
(Only if child is present)
|
10.3
|
HotelPassenger
|
Array
|
Array of guest details for the particular room as requested in hotel
search
|
|
10.3.1
|
Age
|
String
|
Age of the guest
|
Optional
|
10.3.2
|
Email
|
String
|
Email Id of the guest
|
Optional
|
10.3.3
|
Title
|
String
|
Title of the guest
|
Mandatory
Possible values can be Mr, Mrs, Miss, Ms
|
10.3.4
|
FirstName
|
String
|
First name of the guest
|
Mandatory
(Min 2 chars, Max 50 chars)
|
10.3.5
|
MiddleName
|
String
|
Middle name of the guest
|
Optional
|
10.3.6
|
LastName
|
String
|
Last name of the guest
|
Mandatory
(Min 2 chars, Max 50 chars)
|
10.3.7
|
PaxType
|
Enumeration
|
Guest Type
|
Mandatory
- HotelPassenger
- PaxType
Adult = 1,
Child = 2
|
10.3.8
|
LeadPassenger
|
Boolean
|
Represent the lead guest of the booking
|
Mandatory
(Set true if the guest is a lead passenger.
Set false, if the guest is not a lead passenger)
|
10.3.9
|
PassportExpDate
|
Date Time
|
Passport Expiry Date
|
Optional (minimum date time format 0001- 01-01T00:00:00)
|
10.3.10
|
PassportIssueDate
|
Date Time
|
Passport Issuance Date
|
Optional (minimum
date time format 0001- 01-01T00:00:00:00)
|
10.3.11
|
PassportNo
|
String
|
|
Optional
|
10.3.12
|
Phoneno
|
Integer
|
Price of the room
|
Optional
|
10.4
|
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
|
10.5
|
RoomIndex
|
Integer
|
Index of the room
|
Mandatory
|
10.6
|
RatePlanCode
|
String
|
Rate plan code associated with room
|
Mandatory
|
10.7
|
RatePlanName
|
String
|
Name of the Rate plan associated with
room
|
Optional
|
10.8
|
RoomTypeCode
|
String
|
Room Type Code
|
Mandatory
|
10.9
|
RoomTypeName
|
String
|
Room Type Name
|
Optional
|
10.10
|
DayRates
|
Array
|
Per day rate breakup of the room
|
|
10.10.1
|
Amount
|
Decimal
|
Per day price of the room
|
Mandatory
|
10.10.2
|
Date
|
Date
|
Date for which day rate is applicable
|
Mandatory
|
10.11
|
Price
|
Array
|
Price detail of the room
|
|
10.11.1
|
CurrencyCode
|
String
|
Currency in which minimum hotel price
is returned
|
Mandatory
|
10.11.2
|
RoomPrice
|
Decimal
|
Price of the room
|
Mandatory
|
10.11.3
|
Tax
|
Decimal
|
Tax applicable for the room
|
Mandatory
|
10.11.4
|
ExtraGuestCharge
|
Decimal
|
Extra Guest Charges
applicable for the room
|
Mandatory
|
10.11.5
|
ChildCharge
|
Decimal
|
Child Charges applicable for the room
|
Mandatory
|
10.11.6
|
OtherCharges
|
Decimal
|
Other Charges applicable for the room
|
Mandatory
|
10.11.7
|
Discount
|
Decimal
|
Discount applicable for the room
|
Mandatory
(Currently not in use)
|
10.11.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)
|
10.11.9
|
PublishedPriceRoundedOff
|
Integer
|
Published Price (rounded off) of the room
|
Mandatory
(This price is for display purpose only)
|
10.11.10
|
OfferedPrice
|
Decimal
|
Offered Price of the room
|
Mandatory
|
10.11.11
|
OfferedPriceRoundedOff
|
Integer
|
Offered Price (rounded off) of the room
|
Mandatory
(This price is for display purpose only)
|
10.11.12
|
AgentCommission
|
Decimal
|
Commission applicable on the Room Price
|
Mandatory
(TBO will part this
amount if Room Price is on Published)
|
10.11.13
|
AgentMarkUp
|
Decimal
|
Agent Mark Up applicable on the Room Price
|
Mandatory
(Agent will earn this amount if Hotel markup is set from backend)
|
10.11.14
|
ServiceTax
|
Decimal
|
Service tax applicable for the room
|
Mandatory
|
10.11.15
|
TDS
|
Decimal
|
TDS applicable on Commission Earned
|
Mandatory
(This would be deducted only when commission is parted to the agent)
|
10.12
|
RoomPromotion
|
String
|
Room promotion
applicable for the room
|
Optional
|
10.13
|
SmokingPreference
|
Enumeration
|
Smoking Preference associated with room
|
Optional
- SmokingPreference NoPreference = 0,
Smoking = 1,
NonSmoking = 2,
Either = 3
|
10.14
|
Amenities
|
StringList
|
List of room amenities
|
Optional
|
10.15
|
BedTypes
|
Array
|
Array of bed types
|
|
10.15.1
|
BedTypeCode
|
Integer
|
Bed type code
|
Mandatory
|
10.15.2
|
BedTypeDescription
|
String
|
Bed type description
|
Optional
|
10.16
|
Supplements
|
StringList
|
List of supplements
|
Optional
|
10.17
|
SupplierSpecificData
|
String
|
Supplier Specific Data
|
Optional
|
10.18
|
CancellationPolicy
|
String
|
Cancellation policy in text format
|
Mandatory
(Format: Text)
|
10.19
|
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)
|
10.20
|
HotelPolicyDetails
|
String
|
Shows Policies related to hotel
|
Optional
(Shows policies related to hotel)
|
10.21
|
InvoiceCreatedOn
|
Date Time
|
Invoice Creation Date
|
Mandatory
|
10.22
|
InvoiceNo
|
String
|
Invoice Number
|
Mandatory
|
10.23
|
HotelConfirmationNo
|
String
|
Hotel Confirmation Number
|
Optional
|
10.24
|
HotelName
|
String
|
Name of the hotel booked
|
Mandatory
|
10.25
|
StarRating
|
Enumeration
|
Star Rating of the hotel
|
Mandatory
|
10.26
|
AddressLine1
|
String
|
Hotel address details
|
Mandatory
|
10.27
|
AddressLine2
|
String
|
Hotel address details
|
Optional
|
10.28
|
Latitude
|
String
|
Latitude information
|
Optional
|
10.29
|
Longitude
|
|
Longitude information
|
Optional
|
10.30
|
City
|
String
|
Hotel City
|
Mandatory
|
10.31
|
CheckInDate
|
Date
|
Start Date of the requested Stay
|
Mandatory
Format: (dd/mm/yyyy)
|
10.32
|
CheckOutDate
|
Date
|
End Date of the requested stay
|
Mandatory
Format: (dd/mm/yyyy)
|
10.33
|
BookingDate
|
Date
|
Date of Booking
|
Mandatory
Format: (dd/mm/yyyy)
|
10.34
|
NoOfRooms
|
Integer
|
No of Rooms
|
Mandatory
|
10.35
|
SpecialRequest
|
String
|
Reserved for future use
|
Optional
(Reserved for future use)
|
10.36
|
IsDomestic
|
Boolean
|
Is Domestic
|
Mandatory
(Will be set true if domestic city)
|
10.37
|
AgentReferenceNo
|
String
|
Client Reference Number
|
Optional
|
10.38
|
ResponseStatus
|
Enumeration
|
Response status
|
Mandatory
NotSet = 0,
Successfull = 1,
Failed = 2,
InValidRequest = 3,
InValidSession = 4,
InValidCredentials = 5
|
10.39
|
Error
|
|
|
|
10.39.1
|
ErrorCode
|
Integer
|
Code corresponding to the Error
|
Mandatory
|
10.39.2
|
ErrorMessage
|
String
|
Contains error message
|
Mandatory
(Will contain error description corresponding to ErrorCode. Error Message would be blank
in case ErrorCode=0)
|
11
|
IsPerStay
|
Boolean
|
When "IsPerStay" node true, then you will not receive array of DateRate[]
|
Optional
|