Home › Reference › Frequently Asked Questions (FAQ) › Website Integration

How do I integrate forms with my own website?

Sat, 05/10/2008 - 16:56 — admin

Using an IFRAME you can either:

  1. embed a whole Mini-site page without the header and with/without the navigation or
  2. embed any of the individual pages without the header and navigation
  3. embed a customized calendar - you can just link to this too if you want

The rest of this page shows you how to create a link for use in the IFRAME's "src" argument - in general, the HTML code that you'll need is shown below - you'll replace MY_SRC_LINK with the link you choose:

<iframe src="MY_SRC_LINK" width="100%" height="300">
  <p>Your browser does not support iframes.</p>
</iframe>

You will want to change/adjust the width/height and position of the IFRAME on your own web page to make it look right - see more information on how to use IFRAME's here.

To embed a page/pages from the mini-site

Set the 'src' of an IFRAME on your site to a URL of the following form: http://www.myvrzone.com/?cid=UID-PID&embed=1
Where UID is your MyVRZone User ID and PID is an optional property ID number.

To turn on/off the header and navigation, use the following additional arguments in your URL (see examples below for the format)

  • eh=1 - to display a simple header (defaults to not show)
  • em=1 - to display the navigation menu (defaults to not show)
  • nmp=1 - to stop displaying multiple properties if you have more than one (defaults to show all)
  • rp=PID - for Request page only when you have more than one property and want to use a single form for all properties. Set your cid PID to zero (cid=UID-0) and then this means use info from this property for anything that is property-dependent (eg. adult & child ages, base currency, text above the notes box). This will work if all of your properties are the same for these property-specific settings.

To choose Language Translation use the following:

  • tr=1 - to enable translation
  • tr=0 - to disable translation
  • no setting - use the default value set in the Setup>Main >> Account>Info tab

To set a language to translate into by default add the following to the END of the URL

  • #googtrans/en/XX
  • where XX is the standard 2 character ISO-639-1 language identifier (eg "de" for German, "fr" for French (see here for more)
  • for example: #googtrans/en/it will translate into Italian

To display specific pages, add the following before the ? in the URL:

  • Guest/Availability - for the Availability page - essentially shows the calendar in the Mini-site format
  • Guest/GuestBook - for the GuestBook page - see prior feedback/comments
  • Guest/Feedback - for the Feedback page - guests submit their rating and comments here
  • Guest/Ccard - for the Credit Card Payment form (if this is enabled for your account)
  • Guest/ - same as the Availability unless it's a Gold or Platinum plan...

For Gold and Platinum subscribers:

  • Guest/Request - for the Inquiry/Request page
  • Guest/Booking - for the Booking form
  • Guest/ - the property overview (this is the default)

For Gold and Platinum plan subscribers, don't integrate the Booking and Credit Card forms onto your website in this way as the forms need extra information in order to pre-fill and link up to the system correctly. Use the Mini-site for these forms unless you are able to perform a more advanced integration using dynamic server-side code - ask us for further details if interested.

Examples (for User ID UID=4)

For the whole minisite:

For the Request/Inquiry Form (Gold/Platinum Plan):

<iframe src="http://www.myvrzone.com/Guest/Request/?cid=4&embed=1&nmp=1" width="100%" height="300">

  <p>Your browser does not support iframes.</p>

</iframe>

For the Booking Form (Gold/Platinum Plan):

  • http://www.myvrzone.com/Guest/Booking/?cid=4-2&embed=1&nmp=1 to display a blank Booking form showing property with PID=2 with no navigation or header. Bookings using this form will enter the system as Tentative Reservations (the dates are not blocked out). If you are using Quoted Online Booking (Platinum Plan) then this form should not be necessary - instead use the Request form to capture the request and respond to them from the Requests page - a special link to the Booking Form will then be used to pre-fill the booking form and when submitted it will enter the system as a Pending reservation (blocks out the dates).
  • Note that you can add custom fields to the Booking Form by creating Custom Info fields (Platinum Plan ony)
    See this link for more info.

For the Guest Book:

<iframe src="http://www.myvrzone.com/Guest/GuestBook/?cid=4&embed=1&nmp=1" width="100%" height="300">

  <p>Your browser does not support iframes.</p>

</iframe>

For the Feedback/Comment Form:

<iframe src="http://www.myvrzone.com/Guest/Feedback/?cid=4&embed=1&nmp=1" width="100%" height="300">

  <p>Your browser does not support iframes.</p>

</iframe>

For the Credit Card Payment Form:

<iframe src="http://www.myvrzone.com/Guest/Ccard/?cid=4&embed=1&nmp=1" width="100%" height="300">

  <p>Your browser does not support iframes.</p>

</iframe>

NOTE that integrating this form requires the site embedding the IFRAME to use the https protocol for SSL (Secure Sockets Layer) to avoid browser confusion. The data will always be securely submitted because the IFRAME uses SSL but the browser may not show the usual locked symbol. If you do not have an SSL certificate for your site then you can obtain one and create a secure page in which to embed this form. If in doubt, the simplest thing is to use the Guest Zone for online payments.

Calendar - customizable

The calendar can be customized to display in many ways and colors. Please visit this page for interactive help on setting up your preferred format and colors etc. Choose various options there and click the Display button to see what the calendar would look like. When you are happy, paste the IFRAME code there into your website to get the same look.

Rates Table

The rates table has a few configurations that allow you to control how far into the future is displayed, the max number of lines and whether the season name is displayed. In addition, you can choose to display any of the weekly, weekday and weekend rates.

By default, all currencies that are enabled with "Always Include in Quotes" set and a non-zero exchange rate will be displayed in the same table. You can override this with the "cur" parameter shown below.

The basic view can be reached at the following URL:

  • http://www.myvrzone.com/Data/Rates/?cid=4-1 to display the Rates for UID=4 and PID=1
  • append &t=# to choose a theme, set # to the theme number. Default is your own default theme.
  • append &l=# to set the maximum number of lines to display to #
  • append &cur=XXX to set the table to display only currency XXX. XXX is the standard 3-letter abbreviation (shown in the Setup>Main > Account>Currencies tab) - for example, "GBP" for UK Pounds Sterling or "CAD" for Canadian dollars. If the currency is not enabled or has zero exchange rate then the base currency will be displayed instead.
    Use XXX = "all" to display ALL currencies that you have enabled and have a non-zero exchange rate.
  • append &ss=1 to include the special dates - by default they are not displayed
  • append &m=# to display rates covering a maximum of # months - default is 12 months
  • append &s=YYYY-MM-DD to set the start date for the table - format must be YYYY-MM-DD, eg 2009-07-01 for 1st July 2009
  • append &ns=1 to hide the display of the season names in the table
  • append &swk=1 to display a column of weekly rates (this is turned on if no other rates are chosen)
  • append &swkd=1 to display a column of weekday rates (off by default). You must have defined these rates explicity, otherwise a "N/A" will be displayed
  • append &swke=1 to display a column of weekend rates (off by default). You must have defined these rates explicity, otherwise a "N/A" will be displayed
  • append &df=DATE_FORMAT to specify a custom date format (default is 'D%20d-M-y' - see PHP format here) - this must be URL encoded
  • append &nd=# to specify the number of decimal places to use for the rate display (default is 0)
  • append &rfn=TEXT to add a footnote to the table - TEXT must be URL encoded

Examples for UID=4 and PID=1

<iframe src="http://www.myvrzone.com/Data/Rates/?cid=4-1&s=2009-08-01&l=6&swkd=1&swke=1&ns=1" width="100%" height="300">

  <p>Your browser does not support iframes.</p>

</iframe>