Hotel Booking API
This API comes with full hotel Information, live availability searches, booking, cancellation and amendment requests and replies.
Technical Requirements
The API is a XML SOAP web service.
For more information on SOAP visit : http://en.wikipedia.org/wiki/SOAP
There are two main steps in the integration process:
1. Download static data and store local copy
2. Retrieve rates and availability in real time every time a customer visits your website.
1.Rates Search Request XML:
To get the rates for particular date and a particular city.
2.Rates search Reply XML:
You will receive the rates search reply XML as:
| <CheckIn> |
This is the checkin date which was send in rates search request XML.
[yyyy-MM-dd] |
| <CheckOut> |
This is the checkout date which was send in rates search request XML.
[yyyy-MM-dd] |
| <City> |
City code which was send in the request XML. |
| <Currency> |
This is the currency code in which hotel rates are coming. |
HotelList
This is the root node which will contain all the hotels which are available for the requested city for specific checkin and checkout dates.
Hotel
This is the main node which will contain hotel information available as per the request. Number of node for will depend on the number of hotels available with us, as per the conditions which will be entered in rates search request xml. This node will contain different attributes as:
Code |
This is the hotel code which is unique in itself |
Name |
Hotel name |
StarCategory |
Star category i.e. 3,4 or 5 (numeric values) |
Description |
Description of hotel if any. (free text) |
Address |
Address of the hotel. |
Phone |
Phone number of hotel if any. |
Fax |
Fax number of the hotel if any. |
Email |
Email id of hotel if any. |
ImageList
This will contain information for the images of hotel. It will contain nodes named <Image> for image information. Number of nodes for <image> will depend on total number of images avaialable for particular hotel. Some of the attributes are as follows:
Type type of the image.
URL URL of the image.
AvailableRoom
This is the main node for available room information, total number of nodes will depend on the number of rooms requested under the search request. If you have requested for two rooms than this node will be coming twice, single for one room search etc. This node will contain few more nodes as:
| Occupancy |
this node will contain the information for the adults and child according to the search request. |
| Adt |
number of adults as per the request XML. |
| Chd |
number of child as per the request XML. |
HotelRoom
This node will contain the information about the available room acoording to the occupancy and contact with hotels. Number of node for ‘HotelRoom’ depends on the type of rooms available according to the occupany and contracts with hotels. Attributes in the node are as follows:
| Type |
Type of room. |
| Code |
Code of room. |
| Status |
Status of room A- Available R- OnRequest |
| RateType |
Rate type of room PR- Per room and PP- Per Person charge |
| Price |
Price of room. |
| AdltPrice |
Adult price if RateType is PP otherwise as 0 |
| ChldPrice |
Child price if RateType is PP otherwise as 0 |
| MealCode |
Meal code if any. |
| MealDesc |
Description of meal. |
| Des |
Description of room. |
Day
This node will contain the price information for the room as per the number of nights for each day.
| Date |
Date as per request XML |
| Price |
Price for the particular day. |
| Status |
Satatus for particular day. A-Available R- OnRequest |
3.Hotel feature request XML:
To get the features of any of the hotel, we use the Hotel feature request xml.
Hotel Features Reply XML:
Reply XML for hotel feature will include following.
HotelInfo
This is the main node which will contain the hotel information nodes as under:
Hotel This tag will be multiple according to the number of hotel codes send in the request XML. Some of the attribues are as follows:
| Code |
Hotel code |
| Name |
Hotel name |
| CityCode |
City code for hotel |
| Address |
Address of the hotel |
| Description |
Hotel description if any. |
| Location |
Location of hotel. |
| CheckInTime |
Check in time of hotel |
| CheckOutTime |
Check out time of hotel |
| StarCategory |
Star category of hotel |
| URL |
URL of hotel website. |
| Email |
Email id of hotel. |
| Phone |
Phone number of hotel |
| Fax |
Fax number of hotel |
ImageList
This will contain information for the images of hotel. It will contain nodes named <Image> for image information. Number of nodes for <Image> will depend on total number of images avaialable for particular hotel. Some of the attributes are as follows:
Type type of the image.
URL URL of the image.
Facility
This node will contain the facility information for hotel and rooms as well. For hotel facility we have node i.e. HotelFacility and for room facility we have the node i.e. RoomFacility. Description for these nodes are as follows.
HotelFacility it will come only once but it will contain multiple nodes as ‘Description’ which give the information about the facilities available with Hotel.
RoomFacility it will come only once but it will contain multiple nodes as ‘Description’ which give the information about the facilities available with room.
5.Hotel Booking Request XML:
Description for some of the nodes is as under:
CheckIn[Compulsory] This is the checkin date to make a booking. Format is fixed as
[yyyy-MM-dd]
CheckOut[Compulsory] This is the checkout date to make a booking. Again the format for date is fixed as: [yyyy-MM-dd]
Hotel
This will contain the hotel information for which we have to make the booking. Some of the attributes are as follows:
Code[Compulsory]: Hotel Code to make booking.
Name[Compulsory]: Name of the hotel for making the booking.
AgentBkRef[Optional]: This important attribute is the booking refrence number which will be sent by an agent and will be generated by an agent. We will keep this number in our database for future refrence. If agent booking refrence is sent at the time of making booking than it will also be required at the time of cancellation of booking.
|
Customer
This will contain the details for cutomer or pax for which agent will make the booking. Some of the node under this will be as follows:
| <FName>[Compulsory] |
First name of the client |
| <LName>[Optional] |
Last name of the client |
| <Age>[Optional] |
Age of the client |
| <DOB>[Optional] |
Date of birth of client |
| <Phone>[Optional] |
Phone number of client |
| <Mobile>[Optional] |
Mobile number of client |
| <Email>[Optional] |
E-Mail of client |
AvailableRoom
This 'AvailableRoom' node will be multiple if booking is for more than one room, and it will depend on number of rooms to be booked.
| Occupancy
|
this will contain the information for adults and children for particular room.
Adt number of adults for a particular room.
Chd number of children for a particular room. |
| ChdAges |
This tag will be used for entering the age of child. |
| Age |
the <age> tag for child depends on the number of children for a room, for example if number of children are 3 then <age> tag will come 3 times for each child. |
Room
This will contain the information for room to be booked. Some of the attributes are as follows:
| Code |
Room code for making booking |
| Type |
Room type for making booking |
| MealCode |
Meal code which is attached with room |
Hotel Booking Reply XML:
All the nodes and attributes in booking reply are same as they were in booking request. Few attributes will be added to ‘Hotel’ and ‘Room’ node which are as follows:
Hotel_CnfrNo
|
This is the booking refrence number which will be generated by us and will be used for future comunication for particular booking. |
| Status |
Status of the booking.
Confirm or OnRequest |
| Room |
|
| Status |
this is the room confirmation number which will be genrated by our system when we book the requested room, and it will be used for future comunication. |
| Room_CnfrNo |
Status of room in booking.
Confirm or OnRequest |
Booking Cancellation Request XML:
For cancelling any booking done by an agent you have to send a cancellaiton request XML. Some of the nodes are explained as:
Hotel: this will contain the information about the hotels, attributes included in this node are as follows:
| Name |
Hotel name |
| Code |
Hotel code |
| Hotel_CnfrmNo |
This is the hotel booking confirmation number which will be generated by us at the time of making the booking. |
| AgentBkRef |
This is the agent booking refrence which will be sent by an agent at the time of making the booking. It is comulsory to give this number for a cancellation request if it was given at the time of making the booking. |
Room this node will contain the information regarding the rooms, and number of nodes for “Room” will depend on number of rooms you want to cancel. But total number of “Room” node will not exceed the number of rooms booked in particular booking. Some of the attributes in this node are as follows:
| Code |
Room code |
| Room_CnfrNo |
This is the room confirmation number which was generated by us at the time of making the booking. |
Booking Cancellation Reply XML:
You will get the reply xml as cancellation reply XML:
All the nodes and attributes for Hotel and Room are same as per the cancellation request XML except the two new attributes in Room node which are as follows:
| CancelStatus
|
this is the room cancellation status. |
| CancelFee |
this is the cancellation fees. |
Country list request XML:
To get the country lists available with us you need to send this XML as input
Country list reply XML:
The reply XML for country list request will be as follows:
Details regarding the country name and country code will be available in the node i.e. “Country” which will contain the attribute “Code” for country code and country name will be available as inner text of node
11.City list request XML:
To know the city list for any specific country.
12.City list reply XML:
Details regarding the city name and city code will be available in the node i.e. “City” which will contain the attribute “Code” for city code and city name will be available as inner text of node.
13.Booking details request XML:
To get the booking details for the bookings done so far by an agent.
Nodes will be...
DateType |
This node will contain two values either “BKG” for booking and “STY” for stay. Booking Date is the date on which booking is created. Stay date is the date of check in and check out. |
| DateFrom |
This will contain the starting date range for getting the booking details. Format will be fixed as [yyyy-MM-dd]. |
| DateTo |
This will contain the end date range for getting the booking details. Format will be fixed as [yyyy-MM-dd]. |
14. Booking details reply XML:
Few important nodes in Booking details reply.
Hotel: This will be main node which will contain the information about he booked hotel, some of the attibutes are as follows:
| Name |
Hotel name |
| Code |
Hotel code |
| Description |
Hotel description if any. |
| Hotel_CnfrmNo |
This is the hotel booking confirmation number which was generated by us at the time of making the booking. |
And description for some of the nodes under the main node i.e. Hotel is as follows:
BookDate This is the date when the booking was done by agent.
CheckIn This is the check-in date for particular booking.
CheckOut This is the check-out date for particular booking.
CityCode This is the city code for which booking was done.
NoOfRooms This is the number of rooms booked.
BookStatus This is the booking status i.e. Confirmed or OnRequest.
15.Hotel List Request XML:
For getting all the hotels for a specific city.
HotelRequest this is the main node which will contain the required inputs such as:
CountryCode Two digit country code
CityCode This will contain the city code for which hotel list is required.
16. Hotel List Reply XML:
Code this is the hotel code from our database.
Name this is the hotel name from our database.
17. Amend Booking XML Request
This is the XML format to request amending number of rooms
18. Amend Booking XML Reply
It throws out result after adding a room along with confirmation number.
19. Payment Detail XML Request
Requested to find out the deposit details by an agent during a specific period
20.Payment Detail XML Reply
It carries the payment details made as deposit by an agent during the specific period. |