Booking Engine URL Parameters

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://events.hotelsforhope.com/v6?&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://events.hotelsforhope.com/v6?siteid=24530



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.

Parameter Description Example
city Basic hotel list for city searches http://events.hoteslforhope.com/v6?siteid=24530&type=city&city=Phoenix,%20AZ
geo Search properties near a given longitude/latitude (accuracy of up to 3 decimal points)
and encompassing radius.

http://events.hotelsforhope.com/v6?siteId=24530&type=geo&longitude=-105.007&latitude=39.747&radius=10
address Search properties near a given address
http://events.hotelsforhope.com/v6?siteId=24530&type=address&address=1000%20Chopper%20Circle&city=Denver&state=CO
airport Search properties near a 3 character IATA airport code. http://events.hotelsforhope.com/v6?siteId=24530&type=airport&airport=DEN
landmark Search properties near a given landmark.
http://events.hotelsforhope.com/v6?siteId=24530&type=landmark&landmark=Pepsi%20Center
property Search a specific property and display the property detail page for the given property
ID.
http://events.hotelsforhope.com/v6?siteId=24530&type=property&property=359770



The city Search Parameter
The following parameters are used when requesting the city search type

Parameter Type Description Example
city Name of the city to be searched. This should be combined with the state by adding
<cityName>,%20<state abbreviation (or name)> for cities within
states or with <cityName>,%20<country abbreviation (or name)>
for cities within countries. Make sure the URL is property encoded
String http://events.hotelsforhope.com/v6?siteId=24530&type=city&city=Phoenix,%20AZ

http://events.hotelsforhope.com/v6?siteId=24530&type=city&city=Paris,%20FR



The geo Search Parameter
The following parameters are used when requesting the geo search type

Parameter Type Description Example
longitude Decimal The longitude, as a decimal representation (limit of 3 decimal places), for a point
on the Earth

http://events.hotelsforhope.com/v6?siteId=24530&type=geo&longitude=-105.020&latitude=39.7439&radius=10
latitude Decimal The latatude, as a decimal representation (limit of 3 decimal places), for a point
on the Earth

http://events.hotelsforhope.com/v6?siteId=24530&type=geo&longitude=-105.020&latitude=39.7439&radius=10
radius integer Includes all properties located within the given number of miles from the longitude/latitude centerpoint provide by the parameters above. If raduis is omitted, search will default to all properties within a 100 mile radius.
http://events.hotelsforhope.com/v6?siteId=24530&type=geo&longitude=-105.020&latitude=39.7439&radius=10
useKilometers integer Converts the miles display to kilometers. Raduis parameter remains in miles.
http://events.hotelsforhope.com/v6?siteId=24530&type=geo&longitude=-105.020&latitude=39.7439&radius=10&useKilometers
locationLabel String Describes the point defined by longitude and latitude.
http://events.hotelsforhope.com/v6?siteId=24530&type=geo&longitude=-105.020&latitude=39.7439&radius=10&locationLabel=Invesco%20Field%20at%20Mile%20High%20Stadium
noCenter no value necessary Prevents the searched long/lat from being marked with a green icon
http://events.hotelsforhope.com/v6?siteId=24530&type=geo&longitude=-105.020&latitude=39.7439&radius=10&noCenter
map no value necessary Opens up the Google map of all properties by default
http://events.hotelsforhope.com/v6?siteId=24530&type=geo&longitude=-105.020&latitude=39.7439&radius=10&map
points Decimal & String Adds additional Points to the map identified by Longitude and Latitude and Label. Each value separated by |
http://events.hotelsforhope.com/v6?type=geo&siteid=24530&longitude=-115.3090695&latitude=36.2332859&map&points=-115.227721|36.114165|West%20Flamingo%20Park



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.

Parameter Type Description Example
address String Physical address to be searched. This will also be the label provided in the interface.
http://events.hotelsforhope.com/v6?siteId=24530&type=address&address=1701%20Bryant%20St&city=Denver&state=CO
city String City in which the physical address is located.
http://events.hotelsforhope.com/v6?siteId=24530&type=address&address=1701%20Bryant%20St&city=Denver&state=CO
state String 2-character state code in which the physical address is located. Optional.
http://events.hotelsforhope.com/v6?siteId=24530&type=address&address=1701%20Bryant%20St&city=Denver&state=CO
country String 2-character country code in which the physical address is located. Optional for US based addresses.
http://events.hotelsforhope.com/v6?siteId=24530&type=address&address=Place%20Charles%20de%20Gaulle&city=Paris&country=FR
postalCode String In lieu of an address, a postal code may be used to search an area.
http://events.hotelsforhope.com/v6?siteId=24530&type=address&postalCode=80204



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://events.hotelsforhope.com/v6?siteId=24530&type=city&checkIn=12/13/2012&nights=2&rooms=1&adults=2&city=Phoenix,%20AZ

checkOut Date Used in place of nights. Date of check out at the property.

http://events.hotelsforhope.com/v6?siteId=24530&type=city&checkIn=12/13/2012&checkOut=12/15/2012&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://events.hotelsforhope.com/v6?siteId=24530&type=city&checkIn=12/13/2012&nights=2&rooms=1&adults=2&city=Phoenix,%20AZ

rooms Integer Total number of rooms.

http://events.hotelsforhope.com/v6?siteId=24530&type=city&checkIn=12/13/2012&nights=2&rooms=1&adults=2&city=Phoenix,%20AZ

adults Integer Total number of adults in all rooms.

http://events.hotelsforhope.com/v6?siteId=24530&type=city&checkIn=12/13/2012&nights=2&rooms=1&adults=2&city=Phoenix,%20AZ

children Integer Total number of children in all rooms.

http://events.hotelsforhope.com/v6?siteId=24530&type=city&checkIn=12/13/2012&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://events.hotelsforhope.com/v6?siteId=24530&type=city&checkIn=12/13/2012&nights=2&rooms=1&adults=2&currency=EUR&city=Phoenix,%20AZ

pageSize Integer Limit: 1-25 Number of properties to be displayed per page.

http://events.hotelsforhope.com/v6?siteId=24530&type=city&checkIn=12/13/2012&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://events.hotelsforhope.com/v6?siteId=24530&type=city&checkIn=12/13/2012&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)
    • a property listed by default will attach a special tag within the property listing.  The property ID number can also be preceded by a “x” or a  “y” in order to attach additional custom tags within each property.
  • 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)
  • radius (miles)
  • 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
  • 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://events.hotelsforhope.com/v6?&city=anaheim&siteid=24530&amenities=Pets Allowed,Pool)



Property Classes



Property Types

  • propertytypes
  • Hotel
  • Motel
  • Resort
  • Ext. Stay
  • B&B
  • Boutique
  • Vac. Rental
  • Hostel

(multiple can used when seperated by a coma example: http://events.hotelsforhope.com/v6?&city=new york, ny&siteid=24530&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://events.hotelsforhope.com/v6?&checkin=6/11/2007&city=Phoenix, Az&dateFormat=mdy
Euro – http://events.hotelsforhope.com/v6?&checkin=6/11/2007&city=Phoenix, Az&dateFormat=dmy
International ISO- http://events.hotelsforhope.com/v6?&checkin=2007/11/06&city=Phoenix, Az&dateFormat=iso8601