Category:Developers: Difference between revisions

Jump to navigation Jump to search
No edit summary
No edit summary
Line 144: Line 144:


|-
|-
| roomid || id number of room. || The page will open showing this room.  
| advancedays  || number of days  || This will set the initial date to this many days in advance of today. Only applies the first time the page is opened. If advancedays is not used the initial date will be the current date. The first date with availability can be specified by setting advancedays to the value -1.


|-
|-
| propid || id number of property. || The page will open showing this property.
| checkin || check-in full date || The page will open at this check-in date
 


|-
|-
| ownerid || id number of owner.  || The page will open showing all properties and rooms for this owner
| cssfile  ||encoded url || External css file for inclusion in booking page, the file must be available via a secure url (https) and the url must be url encoded. (http://meyerweb.com/eric/tools/dencoder/)


|-
|-
| checkin || check-in full date || The page will open at this check-in date
| cur  ||AUD, CAD, EUR, GBP, NZD, USD, BGN, BRL, CHF, CNY, CZK, DKK, EEK, HKD, HRK, HUF, IDR, INR, JPY, KRW, MXN, MYR, NOK, PHP, PLN, RON, RUB, SEK, SGD, THB, TRY, VND, ZAR|| Opens the page showing the currency converted. (responsive booking page only)
 
|-
| mobile=0  || desktop view  || Display the booking page in desktop view
 


|-
|-
Line 171: Line 166:
|-
|-
| fdate_year || check-in year || The page will open at this check-in date, must be used with fdate_date and fdate_month and be in the format YYYY
| fdate_year || check-in year || The page will open at this check-in date, must be used with fdate_date and fdate_month and be in the format YYYY


|-
|-
| mobile=1 || mobile view  || Display the booking page in mobile view
| group  || keyword || Show only properties that have this group keyword


|-
|-
| numnight || number of nights || Initial value for the number of nights selector
| hidefooter ||yes, no || Do not show the property information at the bottom of the page


|-
|-
| numadult || number of adults || Initial value for the number of adults selector
| hideheader ||yes, no || Do not show the property information at the top of the page


|-
| numchild  || number of children  || Initial value for the number of children selector


|-
|-
| width || page width in px || Useful for embedding the booking page in an Iframe of fixed size
| hideoffer  ||1,2,3,4 || Do not show this offer on the booking page, multiple id's can be specified with a comma separating them.


|-
|-
| numdisplayed || number of nights with prices displayed || Only applies to price table pages, use this to reduce the number of nights for narrow designs
| hideprop ||property id || Do not show this property on the booking page, multiple id's can be specified with a comma separating them.


|-
|-
| referer || text ||This text will be recorded with any bookings originating from this widget allowing tracking of booking sources
| hideroom ||room id || Do not show this room on the booking page, multiple id's can be specified with a comma separating them.


|-
|-
Line 197: Line 191:


|-
|-
| advancedays || number of days || This will set the initial date to this many days in advance of today. Only applies the first time the page is opened. If advancedays is not used the initial date will be the current date. The first date with availability can be specified by setting advancedays to the value -1.
| lang ||en (English), ar (Arabic), bg (Bulgarian), ca (Catalan), hr (Croatian), cs (Czech), da (Danish), de (German),  el (Greek),  es (Spanish), et (Estonian),  fi (Finnish),  fr (French),  he (Hebrew), hu (Hungarian), id (Indonesian - Bahasa Indonesia), is (Icelandic), it (Italian), ja (Japanese), ko (Korean), lt (Lithuanian), mn (Mongolian), my (Burmese), nl (Dutch), no (Norwegian), pl (Polish), pt (Portuguese), ro (Romanian), ru (Russian),  sk (Slovak), sl (Slovenian), sr (Serbian), sv (Swedish), th (Thai), tr (Turkish), vi (Vietnamese),  zh (Chinese simplified),  zt (Chinese traditional) || Sets the default language to open the booking page. (2013 new style booking pages only)


|-
|-
| layout  ||1, 2, 3, 4, 5, 6,  || Opens the responsive version of the booking page in this layout.
| layout  ||1, 2, 3, 4, 5, 6,  || Opens the responsive version of the booking page in this layout.
|-
| maxprop  ||number of properties || Show a maximum of this many properties based on the sort order. Additional properties are hidden.


|-
|-
| hideheader ||yes, no  || Do not show the property information at the top of the page
| maxroom ||number of rooms || Only show a maximum of this many rooms based on the sort order. Additional rooms are hidden.
 
|-
| mobile=1 || mobile view  || Display the booking page in mobile view


|-
|-
| hidefooter ||yes, no || Do not show the property information at the bottom of the page
| mobile=0 || desktop view || Display the booking page in desktop view


|-
|-
Line 212: Line 214:


|-
|-
| lang ||en (English), ar (Arabic), bg (Bulgarian), ca (Catalan), hr (Croatian), cs (Czech), da (Danish), de (German),  el (Greek),  es (Spanish), et (Estonian),  fi (Finnish),  fr (French),  he (Hebrew), hu (Hungarian), id (Indonesian - Bahasa Indonesia), is (Icelandic), it (Italian), ja (Japanese), ko (Korean), lt (Lithuanian), mn (Mongolian), my (Burmese), nl (Dutch), no (Norwegian), pl (Polish), pt (Portuguese), ro (Romanian), ru (Russian), sk (Slovak), sl (Slovenian), sr (Serbian), sv (Swedish), th (Thai), tr (Turkish), vi (Vietnamese), zh (Chinese simplified),  zt (Chinese traditional) || Sets the default language to open the booking page. (2013 new style booking pages only)
| numnight || number of nights || Initial value for the number of nights selector
 
|-
| numadult || number of adults || Initial value for the number of adults selector


|-
|-
| hideprop ||property id || Do not show this property on the booking page, multiple id's can be specified with a comma separating them.
| numchild || number of children || Initial value for the number of children selector
 


|-
|-
| maxprop ||number of properties || Show a maximum of this many properties based on the sort order. Additional properties are hidden.
| numdisplayed || number of nights with prices displayed  || Only applies to price table pages, use this to reduce the number of nights for narrow designs


|-
|-
| hideroom ||room id  || Do not show this room on the booking page, multiple id's can be specified with a comma separating them.
| nogroup || keyword || Exclude properties that have this group keyword
 


|-
|-
| maxroom  ||number of rooms || Only show a maximum of this many rooms based on the sort order. Additional rooms are hidden.
| ownerid || id number of owner.  || The page will open showing all properties and rooms for this owner


|-
|-
| hideoffer  ||1,2,3,4  || Do not show this offer on the booking page, multiple id's can be specified with a comma separating them.
| propid || id number of property. || The page will open showing this property.  


|-
|-
| group || keyword || Show only properties that have this group keyword
| redirect ||encoded url || Redirect to this url, must start with http:// or https:// and be url encoded with a tool like http://meyerweb.com/eric/tools/dencoder/. The booking details are stored in session variables and will be available available to a booking page in an Iframe at your redirect URL as long as the Iframe is not overriding them in it's src url.


|-
|-
| nogroup || keyword || Exclude properties that have this group keyword
| referer || text  ||This text will be recorded with any bookings originating from this widget allowing tracking of booking sources


|-
|-
| cssfile  ||encoded url || External css file for inclusion in booking page, the file must be available via a secure url (https) and the url must be url encoded. (http://meyerweb.com/eric/tools/dencoder/)
| roomid || id number of room. || The page will open showing this room.  


|-
|-
| cur  ||AUD, CAD, EUR, GBP, NZD, USD, BGN, BRL, CHF, CNY, CZK, DKK, EEK, HKD, HRK, HUF, IDR, INR, JPY, KRW, MXN, MYR, NOK, PHP, PLN, RON, RUB, SEK, SGD, THB, TRY, VND, ZAR|| Opens the page showing the currency converted. (responsive booking page only)
| toproom || room always shown on the top of the bookingpage  || (resposive booking page only)  


|-
|-
| redirect  ||encoded url || Redirect to this url, must start with http:// or https:// and be url encoded with a tool like http://meyerweb.com/eric/tools/dencoder/. The booking details are stored in session variables and will be available available to a booking page in an Iframe at your redirect URL as long as the Iframe is not overriding them in it's src url.
| width || page width in px  || Useful for embedding the booking page in an Iframe of fixed size


|}
|}