RapidConnect

XML Specification v. 1.5

By :


Table of Contents

  1. Introduction
  2. Overview
  3. General Considerations.
  4. RC_Ping
  5. RC_Closed_Dates
  6. RC_Availability
  7. RC_Notify
  8. RC_Modify
  9. RC_Cancel
  10. RC_Verify
  11. Security
  12. Implementation

1. Introduction

Understanding the technological needs of our customers and welcoming the benefits that electronic bookings provide to everyone in the industry; Real Resorts has opened its CRS (Central Reservation System) to selected customers through our new standard XML based interface.

This advanced module is fast, easy to implement and very powerful. Innovating, as always, we provide a new XML message for "on the fly" quotes and availability queries, as well as real time reservation notification, modification and cancelation messages.

We have assembled a team of professionals to assist our customers in the planning, development, implementation and certification of this interface with their system(s).

Through this guide you will find everything you need for a swift and painless implementation.

The idea behind this set of interfaces is to provide the wholesaler with a tool that will rapidly replace allotments and cut offs. No matter which system you are using you can interface with a web-service that will provide availability not only for a certain room type but for every room type in the hotel. This is a great opportunity for wholesalers to increase their revenue, changing the traditional ROH reservation for upper categories depending on the needs of their customers. Say good bye to allotments since wholesalers will have complete access to the availability of every room type on the hotel;even presidential suites can be booked and confirmed immediately.

Figure 1. RapidConnect Interface

    Some of the major benefits of this working model are:

  1. Say good bye to allotments and cutoffs. You or your system will be able to check availability on every resort online. So you will know exactly which room category is available for the requested dates through online live inventory. All this completely online and in real time. Even with categories that have had dates reopened.
  2. Now you can easily see and book upgrade categories to increase your revenue. Either a room category is available or not you will always get available room type options.
  3. You can get the exact amount of your reservation; you will be 100% certain of the correct contracted rate according to your contract(s) and/or promos.
  4. Your reservations or cancellations will be in our system the moment the booking is made, so will your modifications.
  5. You will be updated at the very same time; we update the system !!!
  6. You will no longer be bothered with cutoffs and forecast reports, as you will be able to sell until the day of arrival on any category and hotel that remains open.
  7. You will no longer have to send advance forecast or recaps of your confirmed or tentative firm deposit reservations.

2. Overview

The system supports 6 messages, all of them optional. This means the customer can choose the messages its operation needs and can support. All of them work synchronously; the response is sent right back on the same request thread.

The interface on Real Resorts side is always in passive mode, the customer always initiates communications calling the messages it needs for the task it needs accomplished and Real Resorts will always respond accordingly.

RC_Ping (Message 1) Schemas : Request - Response
This is a simple message the customer can call to verify that the interface is up and working as well as to verify security settings and communication links between the two systems.

RC_Closed_Dates (Message 2 ) Schemas : Request - Response
This message will return the closed out dates for a specific hotel for every room category for the dates requested.

RC_Availability (Message 3) Schemas : Request - Response (Quote all Categories)
This message will return the total quote for every room category in a certain hotel for requested dates. If a specific category is requested it will be in first place. Categories are sorted by price, will break day by day rate of the desired stay and will indicate if a day is closed. For every room category total price for the stay will also be indicated. This message will help the travel agent or wholesaler to be sure to have the best and latest available rate for each room category between Real Resorts and the Travel Agent.

RC_Notify (Message 4) Schemas : Request - Response(New Reservation)
This message receives a request for a reservation and will return the reservation number or error code.

RC_Modify (Message 5) Schemas : Request - Response (Modify existing Reservation)
This message receives a request for a modification on an existing reservation. It returns a confirmation number for the modification and the new price or the error code. (The new price may include penalties if they apply)

RC_Cancel (Message 6) Schemas : Request - Response (Cancellations)
This message receives a request to cancel an existing reservation. It returns a confirmation number and any charges (if they apply on the conditions of the original reservation). The system will always accept the cancelation but many errors may occur like: communication failures, wrong hotel number, the reservation does not exists etc. So the system may return an error but it will not deny a cancelation given that the request is properly sent.

RC_Verify (Message 7) Schemas : Request - Response (Verification)
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin et mauris. Mauris vitae arcu. Maecenas metus libero, ultricies a, sagittis scelerisque, porta eu, massa. Proin vel nisi in justo tincidunt eleifend. Curabitur lorem. In dolor dolor, scelerisque ac, malesuada non, commodo dapibus, enim. Vivamus semper. Duis et massa vel orci consectetuer consequat. Etiam et arcu. In hac habitasse platea dictumst. Vivamus sit amet est. Maecenas sodales risus vitae tortor. Ut lacinia neque sed mi. Sed ultrices ultricies ante. Integer convallis metus a felis. Vestibulum quis turpis. Praesent sagittis lectus in ante. Pellentesque ante turpis, posuere eget, faucibus et, rutrum quis, ipsum.

3. General Considerations

The encoding to be used is UTF-8

The date time format is 2005-05-15T07:17:37Z where 2005 is the year, 05 the month, 15 the day, T the time separator, 7 the hour in 24 hour format. 37 the minutes, Z means Zero hour GMT.

Payments are accepted according to the commercial conditions existing between the customer and Real Resorts so if the customer is given credit and a net rate no payment information is required, for commissionable agencies, the customer’s payment information is required in the reservation notification message.

The response of all messages is always sent back on the same thread as the request.

Hotel, room and rate codes are provided to the customer initially and updated frequently via email. If the customer uses the quote message it may receive back promotional rate codes it does not know and they have to be echoed back in the notification message.

All the prices expressed in the interface are in US Dollars. There is no currency element.

The messages can handle 1 room at a time, for multiple room reservations, multiple messages need to be sent.

Possible error codes:
0No error
1Ip address not registered, not authorized.
2Time out error receiving the request. Communication link failure.
3Hotel Code does not exist
4Invalid Date To
5Invalid Date From
6Max Number of Adults Exceeded
7Max Number of Children Exceeded
8Ages of children Exceeded
9Total number of guests per Suite Exceeded
10Minimum number of Adults Not Met
11Suite Type Code Requested not found
12No availability for selected date(s) for this Suite
13Reservation too soon, cut off not met
14Dates in the past
15Credit Spent, reservation cannot be accepted
16Minimum stay applies
17Undefined Error please call technical support
18Hotel Confirmation Number not Found
19Validation against schema failed
20Please verify your Login and Password, no authorized.
21The version of your request is not updated, please verify the new specifications.
22Internal Error, please contact RapidConnect Support
23The Suite Type Requested is not at your contract, please contact your Sales Manager
24Operation Failed; The Booking Id is Required
25No Reservation found with the given criteria
26Operation Failed; Duplicated Agency BookingId
27Max Length of Name or Last Name Exceeded
28You don't have authorization for this transaction
29The server is too busy at the moment. Please try again later
30Children are not allowed in this Hotel
31Invalid Rate
32Login failed. Please check your username and password
33Booking already cancelled
34The requested dates require a minimum stay of [MinLOS]
35The Rate plan requested is not authorized yet, please contact your Sales Manager
3640 Night limit exceeded
37The mail server is full
38The Rate plan requested is not authorized yet, please contact your Sales Manager
39Invalid Currency
40Your password has expired and must be changed
41The password does not meet the password policy requirements

4. RC_Ping

This is a simple message the customer can call to verify that the interface is up and working as well as to verify security settings and communication links between the two systems. The response will echo back the data sent on the request message.
Request:
Response:

5. RC_Closed_Dates

This message asks for the closed dates for all room categories of a certain hotel from X date to Y date. The message responds only with the closed dates, all other dates are open for reservations.

ElementAtributeTypeLengthDescription
Request Fields    
HotelCodeChar3Hotel Code
HotelDateFromDate10From date to show blocked dates
HotelDateToDate10To dates to show blocked dates
Response Fields    
HotelCodeChar3Hotel Code
Hotel/RoomTypeCodeChar3Room Type Code
Hotel/RoomType/DateStatusVarchar8Closed = Closed date
Arrivals= Closed only for arrivlas.
Hotel/RoomType/DateDateDate10Date closed
Request:
Response:

6. RC_Availability

This message receives a request for a quote for a specific stay; it receives the hotel code, the number of adults, the children and their ages, the dates of travel and optionally the room desired. The message will return a quote with the price per night, the availability of each room, bedding and conditions for each room in the hotel and for each rate plan code available ordered by price. If a certain room type is requested it will be shown as first option.

The message always returns all the room type codes available, if the customer requests a specific code this is returned first.

ElementAtributeTypeLengthDescription
Request Fields    
AgencyBookingIdChar10Agency Booking Id
HotelCodeChar3Hotel Code
HotelDateFromDate10From date to show blocked dates
HotelDateToDate10To dates to show blocked dates
HotelRateCodeChar4Contract / Promo Code (Optional)
HotelRatePlanChar2Meal Plan (AI* / EP)
HotelCurrencyChar3Currency Code "ISO 4217"
RoomTypeCodeChar3Room Type Code (Optional)
PassengersAdultsNumber Number of Adults
PassengersTeensNumber Number of Teens
PassengersChildsNumber Number of Children
PassengersInfantsNumber Number of Infants
PassengersmembershipIdFieldString Membershi Id Code
PassengersMembershipTypeString Membershi Id Type (GoldPassport)
SpecialRequests(element)Text8000Text with special Requests
Response Fields    
AgencyBookingIdChar10Agency Booking Id
HotelCodeChar3Hotel Code
HotelDateFromDate10From date to show blocked dates
HotelDateToDate10To dates to show blocked dates
HotelRatePlanChar2Meal Plan (AI* / EP)
HotelCurrencyChar3Currency Code "ISO 4217"
PassengersAdultsNumber Number of Adults
PassengersTeensNumber Number of Teens
PassengersChildsNumber Number of Children
PassengersInfantsNumber Number of Infants
PassengersmembershipIdFieldString Membershi Id Code
PassengersMembershipTypeString Membershi Id Type (GoldPassport)
RoomTypeCodeChar3Room Type Code
RoomType /Bedding(element)Text8000Text with bedding specs of the room
RoomType /DateStatusVarchar8Available / Not Available
RoomType /DateDateDate10Date of the quoted night
RoomType /DateRateCodeChar4Contract / Promo Code (Optional)
RoomType /Date(element)DecimalPrice for the quoted night
RoomType /TotalStatusVarchar8Available / Not Available
RoomType /Total(element)Decimal14.2Price for the quoted stay
RoomType /Description(element)String Description of the Suite type
RoomType /CancelationPolicy(element)Text8000English description of the cancelation policy
RoomType /CancelationRisk(element)Decimal14.2Maximum charge if policy not met.
RoomType /CancelationDeadline(element)Date10Date deadline for 0 charge cancelation (if applyes)
SpecialRequests(element)Text8000Text with special Requests
Request:
Response:

7. RC_Notify

This message is intended for making NEW reservations. This message sends a reservation notification to the Real Resorts Central Reservation System, includes info for check-in, check-out dates, rate plan, rates, taxes and fees, and passengers data.

The message will return the booking confirmation number if successful or an error if the request fails.

ElementAtributeTypeLegthDescription
Request Fields    
AgencyBookingIdChar10Agency Booking Number
HotelCodeChar3Hotel Code
HotelDateFromDate10From date to show blocked dates
HotelDateToDate10To dates to show blocked dates
HotelRatePlanChar2Meal Plan (AI* / EP)
HotelCurrencyChar3Currency Code "ISO 4217"
RoomTypeCodeChar3Room Type Code (Optional)
PassengersAdultsNumber Number of Adults
PassengersTeensNumber Number of Teens
PassengersChildsNumber Number of Children
PassengersInfantsNumber Number of Infants
PassengersmembershipIdFieldString Membershi Id Code
PassengersMembershipTypeString Membershi Id Type (GoldPassport)
Passengers/PassengerLastNameVarchar30Last Name of the guest
Passengers/PassengerNameVarchar23Name of the guest
PaymenttypeChar15Indicates type of payment ("Credit", "Pre-Paid", "CreditCard").
SpecialRequests(element)Text8000Text with special Requests
Response Fields    
AgencyBookingIdChar10Agency Booking Number
HotelCodeChar3Hotel Code
HotelDateFromDate10From date to show blocked dates
HotelDateToDate10To dates to show blocked dates
HotelRatePlanChar2Meal Plan (AI* / EP)
HotelCurrencyChar3Currency Code "ISO 4217"
PassengersAdultsNumber Number of Adults
PassengersTeensNumber Number of Teens
PassengersChildsNumber Number of Children
PassengersInfantsNumber Number of Infants
PassengersmembershipIdFieldString Membershi Id Code
PassengersMembershipTypeString Membershi Id Type (GoldPassport)
Passengers/PassengerLastNameVarchar30Last Name of the guest
Passengers/PassengerNameVarchar23Name of the guest
ReservationidChar10Reservation confirmation number
ReservationTimeStampDateTime20Date and time of confirmation number
Reservation(element)Number14.2Reservation Amount
RoomTypeCodeChar3Room Type Code
RoomType /Bedding(element)Text8000Text with bedding specs of the room
RoomType /DateStatusVarchar8Available / Not Available
RoomType /DateDateDate10Date of the quoted night
RoomType /DateRateCodeChar4Contract / Promo Code (Optional)
RoomType /Date(element)Decimal14.2Price for the quoted night
RoomType /TotalStatusVarchar8Available / Not Available
RoomType /Total(element)Decimal14.2Price for the quoted stay
RoomType /Description(element)String Description of the Suite type
RoomType /Cancellation Policy(element)Text8000English description of the cancellation policy
RoomType /CancellationRisk(element)Decimal14.2Maximum charge if policy not met.
RoomType /Cancellation Deadline(element)Date10Date deadline for 0 charge cancelation (if applyes)
SpecialRequests(element)Text8000Text with special Requests
Request:
Response:

8. RC_Modify

This message receives a request for a modification on an existing reservation. It returns a confirmation number for the modification and the new price or the error code. (The new price may include penalties if they apply).

On the modification message, the original reservation number is needed as well as the NEW details of the stay. The old dates and passenger information are not needed.

ElementAtributeTypeLegthDescription
Request Fields    
ReservationidChar10Original Reservation ID
HotelCodeChar3Hotel Code
HotelDateFromDate10From date to show blocked dates
HotelDateToDate10To dates to show blocked dates
HotelRatePlanChar2Meal Plan (AI* / EP)
HotelCurrencyChar3Currency Code "ISO 4217"
RoomTypeCodeChar3Room Type Code (Optional)
PassengersAdultsNumber Number of Adults
PassengersTeensNumber Number of Teens
PassengersChildsNumber Number of Children
PassengersInfantsNumber Number of Infants
PassengersmembershipIdFieldString Membershi Id Code
PassengersMembershipTypeString Membershi Id Type (GoldPassport)
Passengers/PassengerLastNameVarchar30Last Name of the guest
Passengers/PassengerNameVarchar23Name of the guest
PaymenttypeChar15Indicates type of payment ("Credit", "Pre-Paid", "CreditCard").
SpecialRequests(element)Text8000Text with special Requests
Response Fields    
AgencyBookingIdChar10Agency Booking Number
HotelCodeChar3Hotel Code
HotelDateFromDate10From date to show blocked dates
HotelDateToDate10To dates to show blocked dates
HotelRatePlanChar2Meal Plan (AI* / EP)
HotelCurrencyChar3Currency Code "ISO 4217"
PassengersAdultsNumber Number of Adults
PassengersTeensNumber Number of Teens
PassengersChildsNumber Number of Children
PassengersInfantsNumber Number of Infants
PassengersmembershipIdFieldString Membershi Id Code
PassengersMembershipTypeString Membershi Id Type (GoldPassport)
Passengers/PassengerLastNameVarchar30Last Name of the guest
Passengers/PassengerNameVarchar23Name of the guest
ReservationidChar10Reservation confirmation number
ReservationTimeStampDateTime20Date and time of confirmation number
Reservation(element)Number14.2Reservation Amount
RoomTypeCodeChar3Room Type Code
RoomType /Bedding(element)Text8000Text with bedding specs of the room
RoomType /DateStatusVarchar8Available / Not Available
RoomType /DateDateDate10Date of the quoted night
RoomType /DateRateCodeChar4Contract / Promo Code (Optional)
RoomType /Date(element)Decimal14.2Price for the quoted night
RoomType /TotalStatusVarchar8Available / Not Available
RoomType /Total(element)Decimal14.2Price for the quoted stay
RoomType /Description(element)String Description of the Suite type
RoomType /Cancellation Policy(element)Text8000English description of the cancellation policy
RoomType /CancellationRisk(element)Decimal14.2Maximum charge if policy not met.
RoomType /Cancellation Deadline(element)Date10Date deadline for 0 charge cancelation (if applyes)
SpecialRequests(element)Text8000Text with special Requests
Request:
Response:

9. RC_Cancel

This message receives a request to cancel an existing reservation. It returns a confirmation number and any charges (if they apply on the conditions of the original reservation). The system will always accept the cancelation but many errors may occur like: communication failures, wrong hotel number, the reservation does not exists etc. So the system may return an error but it will not deny a cancelation given that the request is properly sent.

ElementAtributeTypeLegthDescription
Request Fields    
ReservationidChar10Original Reservation ID
HotelCodeChar3Hotel Code
HotelDateFromDate10From date to show blocked dates
HotelDateToDate10To dates to show blocked dates
PassengersmembershipIdFieldString Membershi Id Code
PassengersMembershipTypeString Membershi Id Type (GoldPassport)
Passengers/PassengerLastNameVarchar30Last Name of the guest
Passengers/PassengerNameVarchar23Name of the guest
Response Fields    
HotelCodeChar3Hotel Code
HotelDateFromDate10From date to show blocked dates
HotelDateToDate10To dates to show blocked dates
CancelationidNumber10Cancelation Id
     
Request:
Response:

10. RC_Verify

This message allows you to recover a specific booking or a record set with all the information of a previous booking, whit this message you can retrieve Hotel id, name, arrival date special requests and even the rate per day, you can call it as a simple filter.

ElementAtributeTypeLegthDescription
Request Fields    
ReservationBookingIdNumber10Original Reservation ID
ReservationProcessedFromDate10Processed date or "from date" to retrieve
ReservationProcessedToDate10Processed "to date " to retrieve
HotelCodeChar3Hotel Code
HotelDateFromDate10Arrival date or "from date" to show
HotelDateToDate10Arrival "to dates" to show
Response Fields    
Book(element)Number10Reservation Number given by the agency
BookStatusChar6Hotel Code
Book /AgencyIdChar10Agency Booking Number
Book /HotelCodeChar3Hotel Code
Book /HotelDateFromDate10From date to show blocked dates
Book /HotelDateToDate10To dates to show blocked dates
Book /RoomTypeCodeChar3Room Type Code
Book /RoomType /Bedding(element)Text8000Text with bedding specs of the room
Book /PassengersAdultsNumber Number of Adults
Book /PassengersChildNumber Number of Child
Book /Passengers/PassengerLastNameVarchar30Last Name of the guest
Book /Passengers/PassengerNameVarchar23First Name of the guest
Book /ReservationidNumber10Reservation confirmation number
Book /ReservationTimeStampDateTime20Date and time of confirmation number
Book /Reservation(element)Number14.2Reservation Amount
Book /RoomType /DateDateDate10Date of the quoted night
Book /RoomType /DateRateCodeChar4Contract / Promo Code (Optional)
Book /RoomType /Date(element)Decimal14.2Price for the quoted night
Book /RoomType /TotalStatusVarchar8Available / Not Available
Book /RoomType /Total(element)Decimal14.2Price for the quoted stay
Book /RoomType /Description(element)String Description of the Suite type
Book /RoomType /Cancellation Policy(element)Text8000English description of the cancellation policy
Book /RoomType /CancellationRisk(element)Decimal14.2Maximum charge if policy not met.
Book /RoomType /Cancellation Deadline(element)Date10Date deadline for 0 charge cancelation (if applyes)
Book /SpecialRequests(element)Text8000Text with special Requests
Request:
Response:

11. Security

The interface security is based on SSL and IP address access. Once the interface is set up we only give access to the registered IP(s) given to us in the set up process. All the communication is made over SSL protocol insuring the privacy of all the data sent to and from both systems.

The customer must have at least one static IP to call the messages from and a procedure for adding, changing or deleting IP numbers is given to the customer in the certification process.

As well as the IP verification all the messages need a username and password. This tells us the agency that is contacting us. During the implantation process the customer will be provided with them.


12. Implementation

To implement the interface we have set up the following process.

Discovery Meeting, Review of Specifications.

The customer and Real Resorts IT Teams meet, review the specifications, the customer informs Real Resorts the messages it will use, set up a time line and settle any doubts any of the parties may have. A project leader is assigned by Real Resorts and a project leader is assigned by the customer.

In this face the customer is given access to the testing environment, support contacts, support forms and emergency telephone numbers.

Developing.

The customer develops the code necessary to call the messages. Real Resorts IT team is available for technical support.

Testing and Certification.

Once the customer is ready for testing and certification Real Resorts Project Leader will provide a set of tests for the messages the customer is using. This will be run in a different testing environment where Real Resorts IT team will make sure the messages are received according to the specification to insure a smooth operation.

The messages will include reservation with special characters, French names, past dates, wrong prices, hundreds of guests. Also to make sure the customer can handle all the error codes the interface can send.

Once real resorts and the customer complete the certification process the customer is certified in our system for each message and the customer can start using the messages.