Академический Документы
Профессиональный Документы
Культура Документы
10/2/2008
Glossary..................................................................................................................................................... - 2 -
General instructions ................................................................................................................................. - 2 -
Valid QueryString Parameters ................................................................................................................. - 3 -
Common Tasks ......................................................................................................................................... - 5 -
Pre-selecting the Check Availability Page ......................................................................................... - 7 -
Bypassing the Check Availability Page.............................................................................................. - 7 -
Linking to the Reservation Search Page............................................................................................ - 7 -
Calling the Booking Engine ..................................................................................................................... - 9 -
-1-
Booking Engine Linking Instructions
10/2/2008
Glossary
SBE –Refers to the Reservations.synxis.com Standard (HTML/Linear) Booking Engine. Parameter
accepted by Standard Booking Engine.
* - The addition of an asterisk next to either of the above booking engine codes indicates that
the parameter is either required by that booking engine version or may only be passed to a
certain page. Note any instructions listed in parenthesis under parameter listing.
General instructions
• Parameters passed to Reservations.synxis.com pages must be in the following format:
Parameter name, “=” sign and parameter value:
ParameterName=Value, (ex. Hotel=10081)
• The following root pages are to be used to call the Reservations.synxis.com booking engines
(does not include required or optional parameters):
SBE – https://reservations.synxis.com/lbe/rez.aspx
ABE – https://reservations.synxis.com/opbe/rez.aspx
• When a parameter is the first to be added to the root page URL, separate it from the root
URL with a “?” otherwise separate all parameter and value pairs with an “&”.
• All parameter values listed are for example purposes only. Please verify parameter values
specific to your Property/Chain/Destination before linking.)
• Do not include empty parameters. In the following example, the child parameter should be
omitted: &hotel=10001&Child=&Adult=1
• Do not include invalid parameters in the URL. For example, when opening a booking engine
for the entire chain, do not pass invalid values in the hotel parameter:
&hotel=N/A&Chain=12345
-2-
Booking Engine Linking Instructions
10/2/2008
nights - SBE
Description: Number of Nights. In lieu of Depart, the number of nights may be passed. If
Depart is passed, the Nights parameter will be ignored.
-3-
Booking Engine Linking Instructions
10/2/2008
11 : Chinese (Simplified)
12 : Korean
NOTE: If a locale or lang parameter is passed, then the arrive & depart parameters must be in
the date format that matches the locale. For example, German URL’s must pass their dates as
DD.MM.YYYY and English-US URL’s must pass their dates as MM/DD/YYYY.
room – SBE
Description: Unique RedX Room Type Id. When a valid room Id is passed, the booking engine
will display only the specific associated room type.
RedX Location: Setup > Rooms > Room Configuration
-4-
Booking Engine Linking Instructions
10/2/2008
step – SBE
Description: This is only used by the Standard Booking Engine. It indicates to the booking
engine the starting step in the booking process. The default is step=1 and is not a required
parameter. Step=2 indicates that the availability page should load. If step 2 is used, the arrive
and depart parameters must be present.
path – SBE
Description: This is only used by the Standard Booking Engine. It indicates to the booking
engine the type of process being initiated. The default is step=1 and is not a required
parameter.
Supported values:
1 : Book
2 : Search
3 : Cancel
4 : Modify
bwchk – ABE
Description: If present, this parameter will cause the ABE to perform a bandwidth check on the
guest’s internet connection. If the ABE has not loaded within 15 seconds, the booking engine will
automatically redirect the guest to the SBE, which has lesser bandwidth requirements.
(e.g. ‘bwchk=1’ turns on. If parameter is absent or has a blank value, no bandwidth check is
performed)
firstName – SBE
Description: Passing a value for this parameter will pre-fill the “First Name” field during on the
guest information page.
lastName – SBE
Description: Passing a value for this parameter will pre-fill the “Last Name” field during on the
guest information page.
address – SBE
Description: Passing a value for this parameter will pre-fill the “Address 1” field during on the
guest information page.
Address2 – SBE
Description: Passing a value for this parameter will pre-fill the “Address 2” field during on the
guest information page.
-5-
Booking Engine Linking Instructions
10/2/2008
city – SBE
Description: Passing a value for this parameter will pre-fill the “City” field during on the guest
information page.
postalCode – SBE
Description: Passing a value for this parameter will pre-fill the “Postal Code” field during on the
guest information page.
phone – SBE
Description: Passing a value for this parameter will pre-fill the “Phone” field during on the guest
information page.
contact – SBE
Description: Passing a value for this parameter will pre-fill the “Contact Name” field during on
the guest information page.
email – SBE
Description: Passing a value for this parameter will pre-fill the “Email Address” field during on
the guest information page.
-6-
Booking Engine Linking Instructions
10/2/2008
Common Tasks
This option is chosen by hotels that wish to override the default values prior to checking
availability. For example, if a hotel would prefer that the default number of adults was 2, they
would pass the &Adult=2 parameter when linking into the booking engine.
If you wish to pre-select the values on the check availability page, you may pass any combination
of the following parameters: Arrive, Depart, Nights (SBE only), Adult, Child, Iata and Promo.
If you wish to by-pass the “Check Availability” page in the Standard Booking Engine, you may
directly call the “Room Availability” page. This option is often chosen when the hotel opts to
include the availability criteria (arrival date, departure date, adults, children, etc) on their own
site. When a customer on their website opts to check availability, they will be directed to the
Room Availability results.
There are 4 required parameters to access the Room Availability page: Hotel, Arrive, Depart and
Step. The Adult and Child parameters are optional and will default to 1 adult and no children.
The Step parameter must be set to 2 for the availability page to display.
If you wish to by-pass the booking process and directly access the Amend Reservations page in
the Standard Booking Engine, you may do so using parameters. This option is chosen when
the hotel wishes to offer the ability for customers to enter their identifying reservation criteria
(email, confirmation number) on their own site. When a customer on their website opts to
search for a reservation, they will be directed to the Amend Reservation search results.
There are 4 required parameters to access the Room Availability page: Email, Confirm, Path and
Step. The Step and Path parameters must both be set to 2 for the Amend Reservation page to
display.
If you wish to by-pass the “Check Availability” page in the Standard Booking Engine, you may
directly call the “Reservation Search Page”. There are three required parameters Hotel, Step and
-7-
Booking Engine Linking Instructions
10/2/2008
Path. The Step parameter must be set to 2 and the Path parameter must be set to 2 for the
search page to display.
This option allows the hotels to include a “Find Reservation” or a “Modify Reservation” link on
their website.
-8-
Booking Engine Linking Instructions
10/2/2008
Depending upon which booking engine you are using and the layout of your own website (if
applicable), you have options for how you choose to call the Synxis booking engine page. Some
of these options require technical expertise and others require special consideration due to issues
of customer experience. Below are listed the current methods supported by
Reservations.synxis.com for the calling of our booking engine pages.
This method is best for the Standard Booking Engine, but can be used with the One Page
Booking Engine. Synxis discourages this option for calling the ABE due to the heavy use
of Flash in the ABE which does not allow users to control the state of the booking engine
via the browsers “Back” and “Forward” buttons. Please see “Link to Synxis using a
POPUP window” for more information on this topic.
When users click on your “Reservations” link, the current browser window remains and a
“JavaScript” loads the Synxis booking engine into a new window without any of the
excess browser functionality like menus and Back and Forward buttons. Synxis can
provide technical assistance with this, although the JavaScript knowledge required for
implementation is very minimal.
Synxis recommends this method for the ABE primarily to prevent the user from being
inclined to navigate with these buttons rather than using the Flash interface. The Flash
booking engine is a self contained application which only uses the browser as a holder to
launch within. Secondarily, Synxis recommends this method for optimal viewing area.
Since the flash movie dimensions are fixed and cannot be changed, the size of the
window should be fixed to accommodate the average internet user. Currently, most
internet users are still using screen resolutions of 800 pixels by 600 pixels. By opening a
window without menus and button bars, the most space is available for the user to see
the entire booking engine without having to scroll.
With either of these methods, Synxis has the expertise to answer any and all of your questions
and provide technical assistance as needed. Please contact you service representative with any
questions.
-9-