| 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
|
Rooms
|
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
|
DayRates
|
Array
|
Per day rate breakup of the room
|
|
| 10.6
|
Net Amount
|
Decimal
|
Per day price of the room
|
Mandatory
|
10.7
|
CancellationPolicy
|
String
|
Cancellation policy in text format
|
Mandatory
(Format: Text)
|
| 10.8
|
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.9
|
HotelPolicyDetails
|
String
|
Shows Policies related to hotel
|
Optional
(Shows policies related to hotel)
|
| 10.10
|
InvoiceCreatedOn
|
Date Time
|
Invoice Creation Date
|
Mandatory
|
| 10.11
|
InvoiceNo
|
String
|
Invoice Number
|
Mandatory
|
| 10.12
|
HotelConfirmationNo
|
String
|
Hotel Confirmation Number
|
Optional
|
| 10.13
|
HotelName
|
String
|
Name of the hotel booked
|
Mandatory
|
| 10.14
|
StarRating
|
Enumeration
|
Star Rating of the hotel
|
Mandatory
|
| 10.15
|
AddressLine1
|
String
|
Hotel address details
|
Mandatory
|
| 10.16
|
AddressLine2
|
String
|
Hotel address details
|
Optional
|
| 10.17
|
City
|
String
|
Hotel City
|
Mandatory
|
| 10.18
|
CheckInDate
|
Date
|
Start Date of the requested Stay
|
Mandatory
Format: (dd/mm/yyyy)
|
| 10.19
|
CheckOutDate
|
Date
|
End Date of the requested stay
|
Mandatory
Format: (dd/mm/yyyy)
|
| 10.20
|
BookingDate
|
Date
|
Date of Booking
|
Mandatory
Format: (dd/mm/yyyy)
|
| 10.21
|
NoOfRooms
|
Integer
|
No of Rooms
|
Mandatory
|
| 10.22
|
SpecialRequest
|
String
|
Reserved for future use
|
Optional
(Reserved for future use)
|
| 10.23
|
IsDomestic
|
Boolean
|
Is Domestic
|
Mandatory
(Will be set true if domestic city)
|
| 10.24
|
AgentReferenceNo
|
String
|
Client Reference Number
|
Optional
|
| 10.25
|
ResponseStatus
|
Enumeration
|
Response status
|
Mandatory
NotSet = 0,
Successfull = 1,
Failed = 2,
InValidRequest = 3,
InValidSession = 4,
InValidCredentials = 5
|
| 10.26
|
Error
|
|
|
|
| 10.27.1
|
ErrorCode
|
Integer
|
Code corresponding to the Error
|
Mandatory
|
| 10.27.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
|