|
Booking Engine Parameters provide affiliates the ability to deep link into specific
booking engine pages from their own site. This allows full customization of user
experience on the affiliate's own website before linking over to complete the booking
transaction. The following section lists all the parameters available to affiliates,
what they do, and how to use them in a query string.
Parameter Guidelines:
All parameters must be properly URL encoded.
For example: %20 is equivalent to a space and is required to define a city name
such as San Diego in the city parameter. This needs to be encoded as - http://www.reservetravel.com/v6?type=city&city=San%20Diego
The siteId Parameter
Site ID only required parameter. This will link a user into a specific affiliate site and give credit to that site ID when a booking is completed.
|
Parameter
|
Type
|
Description
|
Example
|
|
siteId
|
Integer
|
Unique ID issued upon affiliate registration. This is required to give booking credit
to the appropriate affiliate.
|
http://www.reservetravel.com/v6?siteId=64
|
Don't have a site ID? Register for an affiliate account at one of the following sites:
The type Parameter
The type parameter must be included with any search. Failure to include
a search type will result in a redirection to the search page of your affiliate.
If a redirect occurs, the system will preserve the affiliate site ID and the affiliate will be credited with
all bookings made through that redirect.
The city Search Parameter
The following parameters are used when requesting the city search type
The geo Search Parameter
The following parameters are used when requesting the geo search type
The address Search Parameter
The following parameters are used when requesting the address search type. Address searches convert the address to longitude and latitude and return properties located within a given radius.
The Rates and Availability Parameters
The rates and availability parameters can be added to any search type. The rates
and availability parameters allow the affiliate to have a user select their exact
search criteria on the affiliate's website before being passed over to the booking
engine to complete their transaction. These parameters are vital to a seamless transition
from the affiliate website to the booking engine.
|
Parameter
|
Type
|
Description
|
Example
|
|
checkIn
|
Date
|
Date of check in at the property.
|
http://www.reservetravel.com/v6?siteId=64&type=city&checkIn=&nights=2&rooms=1&adults=2&city=Phoenix,%20AZ
|
|
checkOut
|
Date
|
Used in place of nights. Date of check out at the property.
|
http://www.reservetravel.com/v6?siteId=64&type=city&checkIn=&checkOut=&rooms=1&adults=2&city=Phoenix,%20AZ
|
|
nights
|
Integer
|
Used in place of checkOut. Number of consecutive nights guest(s)
will be staying after check in at the property.
|
http://www.reservetravel.com/v6?siteId=64&type=city&checkIn=&nights=2&rooms=1&adults=2&city=Phoenix,%20AZ
|
|
rooms
|
Integer
|
Total number of rooms.
|
http://www.reservetravel.com/v6?siteId=64&type=city&checkIn=&nights=2&rooms=1&adults=2&city=Phoenix,%20AZ
|
|
adults
|
Integer
|
Total number of adults in all rooms.
|
http://www.reservetravel.com/v6?siteId=64&type=city&checkIn=&nights=2&rooms=1&adults=2&city=Phoenix,%20AZ
|
|
children
|
Integer
|
Total number of children in all rooms.
|
http://www.reservetravel.com/v6?siteId=64&type=city&checkIn=&nights=2&rooms=1&adults=2&children=2&city=Phoenix,%20AZ
|
|
currency
|
String
|
ISO Value (i.e. USD, GBP, EUR) of the currency code for rates to be displayed in.
Native currency will also be displayed.
|
http://www.reservetravel.com/v6?siteId=64&type=city&checkIn=&nights=2&rooms=1&adults=2¤cy=EUR&city=Phoenix,%20AZ
|
|
pageSize
|
Integer
|
Limit: 1-25 Number of properties to be displayed per page.
|
http://www.reservetravel.com/v6?siteId=64&type=city&checkIn=&nights=2&rooms=1&adults=2&pageSize=15&city=Phoenix,%20AZ
|
|
cid
|
String
|
Affiliate generated campaign ID string which will be recorded with the reservation.
This is also used to control themes.
|
http://www.reservetravel.com/v6?siteId=64&type=city&checkIn=&nights=2&rooms=1&adults=2&cid=MyCoolNewAdCampaign&city=Phoenix,%20AZ
|
Search Parameters
- address
- city
- state (2 digit code - if no state don't use)
- country (ISO value)
- zipcode
- radius (miles)
- airport
- code
- name
- geo
- promptForCheckIn (popup date selector to force date selection)
- latitude
- longitude
- hotellist
- landmark (name - validate with Landmark Table)
- properties (Limits the list of hotels displayed to the property numbers used. Comma
delimited list)
- property
Filters that restrict query results
- hotelname
- amenities
- propertyclasses
- propertytypes
- pagesize
Parameters that Filter Results Special Features
- map (normally loaded closed. Loads open when used)
- mapsize (Zoom level of hotel list map. (Values 1 and zoom in up to 17. Default approx.
11))
- locationlabel (Identifies the location being searched around)
- satellite (Loads Google map in satellite view)
- message (inserts message in hotel listing)
- nocomm (restricts pay at hotel rates from displaying)
- nonets (restricts pre-pay rates from displaying)
- pagesize (number of hotels to display on a single web page (15 standard, 40 max.))
- noSplash (prevents splash screen only on initial link in)
- Amenities
- Amenities
- Airport Shuttle
- Complimentary Breakfast
- Fitness Center
- Free Local Calls
- Internet Access
- Kitchen/Kitchenette
- Pets Allowed
- Pool
- Restaurant on-site
- Social Hour (multiple can used when seperated by a coma example:
http://www.reservetravel.com/v6?type=hotellist&city=anaheim&siteid=64&amenities=Pets
Allowed,Pool)
Property Classes
- propertyclasses (AKA PRICE CLASS)
- 5 Stars (LUXURY)
- 4 Stars (PREMIUM)
- 3 Stars (MODERATE)
- 2 Stars (BUDGET)
- 1 Star (ECONOMY) (multiple can used when seperated by a coma example: http://www.reservetravel.com/v6?type=hotellist&city=anaheim&siteid=64&propertyclasses=4
Stars,5 Stars)
Property Types
- propertytypes
- Hotel
- Motel
- Resort
- Ext. Stay
- B&B
- Boutique
- Vac. Rental
- Hostel
(multiple can used when seperated by a coma example: http://www.reservetravel.com/v6?type=hotellist&city=new
york, ny&siteid=64&propertytypes=Vac. Rental,Ext. Stay)
Property Parameters that Filter Results
- tab (default General Info)
- Amenities
- Photos
- Map
- Date Formats (2)
V6 supports all three date formats, US, Euro & International (ISO). Once linked
in all dates will be interpreted and printed with this format. Token must be dateFormat,
and is case sensitive. Token is not required and V6 will default to US if no format
passed is passed.
US -
http://www.reservetravel.com/v6?type=hotellist&checkin=6/11/2007&city=Phoenix, Az&dateFormat=mdy
Euro -
http://www.reservetravel.com/v6?type=hotellist&checkin=6/11/2007&city=Phoenix, Az&dateFormat=dmy
International ISO-
http://www.reservetravel.com/v6?type=hotellist&checkin=2007/11/06&city=Phoenix,
Az&dateFormat=iso8601
|