The purpose of this document is to help developers who will be handling the technical integration between HL WebServices and other booking systems and it describes the content that is made available through our web service (that is, a JSON REST service) and all the available calls that the service provides, along with the recommended workflow. This document is intended to be used by the members of the technical team from the 3rd party booking system as a guideline throughout the integration process. The integration between the two systems (HolidayLognin.com and 3rd party booking system) will allow the client to book, view, and manage reservations in their own booking system.
BL WebServices works like any other hotel service provider. Two main sets of operations can be performed against the service:
- Static data retrieval (countries, destinations, hotels) – the client must retrieve all static data to their own repository since all of the other operations available within the service only work by using ids and codes, in order to minimize the network traffic, thus greatly improving the responses’ timeframes
- Availability search and booking operations – these need to be performed in a certain order to benefit from the service’s functionality (a complete recommended booking workflow diagram is available on the next page):
- Availability Search
The search for available hotel options can be performed either by destination or by the hotel. The response will provide a list of hotels with all their available options according to the search criteria. Each option may contain a room or more number of rooms (depending on the number of requested rooms) and contains a unique identifier that will be passed to all future operations that help the service to isolate the option details. Also, each option will contain an availability status: available (in which case, booking the option will most probably result in a confirmed reservation) or on request (in which case, booking this option will result in a pending reservation, that will need to be confirmed, canceled or rejected by the client manually in the back office application).
A maximum of 9 rooms may be requested (and then booked) in a single call.
Before initiating a new search request, the client needs to always open a new session with the service. The received session-id is a mandatory parameter in the search, option details, and booking requests.
- Option details
This operation is mandatory before making the booking request. It is used to retrieve the cancellation policy, which should be displayed in the client’s supplication for the end-user to agree to before booking. The response also contains the price breakdown (per room, per day) and any supplements or discounts that may be included in the rate.
The operation is used to book an option for which the details were previously retrieved. If the response doesn’t contain a booking reference, then the booking was not made on our side and an error message should also be present in the same response. The booking reference is later used when getting the booking details, canceling the booking, or issuing the voucher for the booking.