|
General Plugin Methods Controlling the Plugin List of Controls |
|
General
Temando provides a plugin facility for external websites to plug our booking service into their site. There are numerous methods of achieving this and also for controlling the display or actions taken by the plugin.
The following details all this information.
Plugin methods
Embedded
A website can embed the booking service into their page using an iframe. For the best display the size of the iframe should be width of the 650 and a height of 500.
Example (the "successPage" would be a page of your choosing):
<iframe src="https://www.temando.com/plugin/request.html?successPage=http%3A%2F%2Fwww.mysite.com%2FbookingSuccessPage.html" width="650" height="500"><p>Your browser does not support iframes. You will be required to upgrade your browser before you can proceed with this step.</p></iframe>
Pop-Up
A website can provide the booking service via a popup window. For the best display the size of the popup window should be width of the 650 and a height of 520.
Example (the "successPage" would be a page of your choosing):
<a href="JavaScript:window.open
('https://www.temando.com/plugin/request.html?
successPage=http%3A%2F%2Fwww.mysite.com%2FbookingSuccessPage.html'
,'mywindow','width=650,height=520,toolbar=no,location=no,directories=no,
status=yes,menubar=no,scrollbars=yes,copyhistory=no,resizable=no');">
Click here to send your freight</a>
Redirect
A website can provide the booking service via a redirect. By doing this the user will be redirected away from your website but returned after the booking process has completed.
Example (the "successPage" would be a page of your choosing):
<a href="https://www.temando.com/plugin/request.html?successPage=http%3A%2F%2Fwww.mysite.com%2FbookingSuccessPage.html">Click here to send your freight</a>
The url to be supplied to any of the methods used is https://www.temando.com/plugin/request.html.
Various control variables can also be supplied as parameters. These allow you to control how the plugin will behave (eg. redirects to a certain page on success) or to autopopulate certain fields, which also lock the fields preventing usres from changing the value (eg. origin location). See Controlling the Plugin below for further details.
A working example page is available to view each of these methods in action. Click here to view this site.
Controlling the Plugin
There are 2 types of controls that can be provided to the plugin via the url (as parameters): behaviour controls and autopopulate controls.
To specify a control you simply add the details to the plugin url. The details are the name of the control and assigning a value.
For example, if you want the plugin to redirect to the page http://www.mysite.com/bookingSuccessPage.html once the user has booked their freight successfully and redirect to the page http://www.mysite.com/bookingFailurePage.html if there was an error or the user decided to cancel out of the booking process then the url would be:
https://www.temando.com/plugin/request.html?successPage=http%3A%2F%2Fwww.mysite.com%2FbookingSuccessPage.html&cancelPage=http%3A%2F%2Fwww.mysite.com%2FbookingFailurePage.html&errorPage=http%3A%2F%2Fwww.mysite.com%2FbookingFailurePage.html
You may have noticed that certain characters were changed (eg. http:// was changed to http%3A%2F%2F). This is because certain characters must be escaped to prevent them from being interpretted incorrect. A list of what characters must be escaped is available from here.
Behaviour Controls
Behaviour controls allow you to specify how the plugin will behave. This includes things such as: what page the plugin should redirect to once the user has completed their booking, the redirect page for failure, etc.
See List of Controls for a complete list of these controls.
AutoPopulate Controls
AutoPopulate controls allow you to specify values for fields requiring input from the user. If a value has been supplied then the field will also be locked preventing the user from changing it. The advantage behind locking the fields is that you can control certain details of the booking. For example, if a user of your site has purchased an item you may want to predefined (ie. autopopulate) the details of the item, rather then allowing them to enter this information themselves (possibly resulting in human errors).
See List of Controls for a complete list of these controls.
List of Controls
The following details all the controls that can be provided as parameters to the plugin's url.
Note: all assigned values must have special characters escaped (eg. ':', '/', etc). A list of what characters must be escaped is available from here.
Behaviour Controls
| Name | Details | Mandatory | Limitations |
|---|---|---|---|
successPage |
The location that the plugin will redirect to once the user has completed the booking process. The parameter "TEM_SUCCESS_RESULT" will be added to the success page's url, with the assigned value being the newly created request id. |
This control is not mandatory but should be supplied if you want the user to be redirected to a specific page after completing the booking. If not supplied and the method is either Embedded or Redirect, the browser will be redirected to the Temando success page. If not supplied and the method is Pop-Up, then the popup window will be closed. |
n/a |
cancelPage |
The location that the plugin will redirect to if the user has choosen to cancel out of the booking process. The parameter "TEM_CANCEL_REASON" will be added to the cancel page's url, with the value being "CANCELLED_AT_REQUEST". |
This control is not mandatory but will default to the supplied successPage if no value provided. |
n/a |
errorPage |
The location that the plugin will redirect to if an error has occurred during the booking process. The parameter "TEM_ERROR_REASON" will be added to the error page's url. The options for this parameter are:
|
This control is not mandatory but will default to the supplied successPage if no value provided. |
n/a |
promotionCode |
The promotion code associated with an affiliate. |
This is not mandatory. |
Must be no greater than 10 characters. |
AutoPopulate Controls
Anything Section
| Name | Displayed Title | Details | Limitations |
|---|---|---|---|
numberSections |
<not displayed> |
The number of Anything sections to display. |
Must be between 1 and 9. |
All of the following variables must be followed by a "_" then a section number. For example, if specifying a class value of Freight and only 1 Anything section is to be displayed (which is the default if numberSections is not supplied) then the entry would be "class_1=Freight". |
|||
class |
Class |
The class of the item being sent. |
Must be: Freight, General Goods, Vehicle or Other. |
subclass |
Specifically |
The subclass of the item being sent. |
Applied only if class is: General Goods, Vehicle or Other.
|
mode |
Mode |
The mode of the item being sent. |
Applied only if class is Freight. |
tlSubclass |
Number of Pallets |
The number of pallets being sent. |
Applied only if class is Freight. |
packaging |
Packaging |
The type of packaging used for the item being sent. |
Applied only if:
Must be (given the following cases):
|
palletType |
Pallet Type |
The pallet type being sent. |
Applied only if:
Must be: Chep, Loscam, Plain or Not Required. |
palletNature |
Pallet Nature |
The pallet nature being sent. |
Applied only if:
Must be: Exchange, Transfer or Not Required. |
containerDimensions |
Container Dimensions |
The dimensions of the container being sent. |
Applied only if mode is Container. |
containerNature |
Container Nature |
The nature of the container being sent. |
Applied only if mode is Container. |
containerRegistered |
Registered |
Whether the container is registered. |
Applied only if mode is Container. |
qualifierFreightGeneralFragile |
Fragile Contents |
If the item being sent is fragile. |
Applied only if class is: Freight or General Goods. |
qualifierVehicleMake |
Make |
The make of the vehicle being sent. |
Applied only if class is Vehicle.
|
qualifierVehicleModel |
Model |
The model of the vehicle being sent. |
Applied only if class is Vehicle.
|
qualifierVehicleDescription |
Type |
The description of the vehicle being sent. |
Applied only if class is Vehicle.
|
qualifierVehicleYear |
Year |
The year of the vehicle being sent. |
Applied only if class is Vehicle.
|
qualifierVehicleRunning |
Drivable |
If the vehicle being sent is running. |
Applied only if class is Vehicle. |
qualifierVehicleRegistered |
Registered |
If the vehicle being sent is registered. |
Applied only if class is Vehicle. |
qualifierVehicleRegistration |
Registration |
The registration of the vehicle being sent. |
Applies only if class is Vehicle. |
qualifierBoatSeaworthy |
Seaworthy |
If the boat being sent if seaworthy. |
Applied only if class is Boat. |
qualifierBoatTrailer |
Do you have a Trailer |
If the boat being sent has a trailer. |
Applied only if class is Boat. |
qualifierBoatMake |
Make |
The make of the boat being sent. |
Applied only if class is Boat. |
qualifierBoatModel |
Model |
The model of the boat being sent. |
Applied only if class is Boat. |
qualifierBoatHullType |
Hull Type |
The hull type of the boat being sent. |
Applied only if class is Boat. |
qualifierLivestockType |
Type |
The type of the livestock being sent. |
Applied only if class is Animal and subclass is Livestock. |
qualifierAnimalVaccinated |
Vaccinated |
If the animal being sent has been vaccinated. |
Applied only if class is Animal. |
qualifierAnimalAge |
Age (years) |
The age of the animal being sent. |
Applied only if class is Animal. |
qualifierAnimalRegistered |
Registered |
If the animal being sent is registered. |
Applied only if class is Animal. |
qualifierAnimalBreed |
Breed |
The breed of the animal being sent. |
Applied only if class is Animal. |
qualifierAnimalType |
Type |
The type of the animal being sent. |
Applied only if class is Animal and subclass is Other. |
qualifierAnimalSex |
Sex |
The sex of the animal being sent. |
Applied only if class is Animal. |
qualifierAnimalCrate |
Crate Details |
The type of crate to be used to transport the animal being sent. |
Applied only if class is Animal and subclass is Dog, Cat, Bird, Livestock or Other. |
length |
Length |
The distance measurement type to be used for the Length, Width and Height values. |
Applied only if:
Must be between 1 and 10000. |
width |
Width |
The weight measurement type to be used for the Weight values. |
Applied only if:
Must be between 1 and 10000. |
height |
Height |
The length of the item being sent. |
Applied only if:
Must be between 1 and 10000. |
weight |
Weight |
The width of the item being sent. |
Applied only if:
Must be between 1 and 10000. |
distanceMeasurementType |
Measure (Measurement Section) |
The height of the item being sent. |
Applied only if:
Must be: Centimetres, Metres, Inches or Feet. |
weightMeasurementType |
Measure (Weight Section) |
The weight of the item being sent. |
Applied only if:
Must be: Grams, Kilograms, Ounces or Pounds. |
quantity |
Quantity |
The number of items being sent. |
Applied only if:
Must be between 1 and 10000. |
description |
Description |
Further details of the item being sent, that have not been specified in other elements. |
Applied only if:
Must be no greater than 1000 characters. |
Anywhere Section
| Name | Displayed Title | Details | Limitations |
|---|---|---|---|
itemMethod |
Delivery Method |
The delivery method for the item being sent. |
Must be: Door to Door or Depot to Depot. |
originCountry |
Country (Origin Section) |
The country that the item is being sent from. |
Must be a 2 letter code representing a country as specified by ISO 3166 (ie. International Standards Organisation – http://www.iso.org). |
originCode |
Postal Code (Origin Section) |
The postal code of the location that the item is being sent from. |
Applies only if itemMethod is Door to Door. |
originSuburb |
Suburb (Origin Section) |
The suburb of the location that the item is being sent from. |
Applies only if itemMethod is Door to Door. |
originState |
State/Province/County (Origin Section) |
The state of the location that the item is being sent from. |
Applies only if itemMethod is Depot to Depot. |
originCity |
City/Town (Origin Section) |
The city or town of the location that the item is being sent from. |
Applies only if itemMethod is Depot to Depot. |
destinationCountry |
Country (Destination Section) |
The country that the item is being sent to. |
Must be a 2 letter code representing a country as specified by ISO 3166 (ie. International Standards Organisation – http://www.iso.org). |
destinationCode |
Postal Code (Destination Section) |
The postal code of the location that the item is being sent to. |
Applies only if itemMethod is Door to Door. |
destinationSuburb |
Suburb (Destination Section) |
The suburb of the location that the item is being sent to. |
Applies only if itemMethod is Door to Door. |
destinationState |
State/Province/County (Destination Section) |
The state of the location that the item is being sent to. |
Applies only if itemMethod is Depot to Depot. |
destinationCity |
City/Town (Destination Section) |
The city or town of the location that the item is being sent to. |
Applies only if itemMethod is Depot to Depot. |
destinationIs |
Destination Is (Destination Section) |
What type of location is receiving the item. |
Applies only if itemMethod is Door to Door. |
destinationBusPostalBox |
Postal Box (Destination Section) |
Is the receiving location a postal box? |
Applies only if:
Must be: Y or N. |
destinationBusUnattended |
Unattended (Destination Section) |
Will the receiving location be unattended? |
Applies only if:
Must be: Y or N. |
destinationBusDock |
Loading Dock (Destination Section) |
Does the receiving location have a dock? |
Applies only if:
Must be: Y or N. |
destinationBusForklift |
Forklift (Destination Section) |
Does the receiving location have forklift? |
Applies only if:
Must be: Y or N. |
destinationBusLoadingFacilities |
Loading Facilities (Destination Section) |
Does the receiving location have loading facilities? |
Applies only if:
Must be: Y or N. |
destinationBusInside |
Inside delivery (Destination Section) |
Does the receiving location require an inside pickup? |
Applies only if:
Must be: Y or N. |
destinationBusNotifyBefore |
Notify before delivery (Destination Section) |
Does the receiving location require notification before pickup? |
Applies only if:
Must be: Y or N. |
destinationBusLimitedAccess |
Limited access delivery (Destination Section) |
Does the receiving location have limited access? |
Applies only if:
Must be: Y or N. |
destinationBusHeavyLift |
Heavy lift help (Destination Section) |
Will the item be a heavy lift? |
Applies only if:
Must be: Y or N. |
destinationBusTailgateLifter |
Tailgate lifter (Destination Section) |
Does the receiving location require a tailgate lifter? |
Applies only if:
Must be: Y or N. |
destinationBusContainerSwingLifter |
Container swing lifter (Destination Section) |
Does the receiving location require a container swing lifter? |
Applies only if:
Must be: Y or N. |
destinationResPostalBox |
Postal Box (Destination Section) |
Is the receiving location a postal box? |
Applies only if:
Must be: Y or N. |
destinationResUnattended |
Unattended (Destination Section) |
Will the receiving location be unattended? |
Applies only if:
Must be: Y or N. |
destinationResInside |
Inside delivery (Destination Section) |
Does the receiving location require an inside pickup? |
Applies only if:
Must be: Y or N. |
destinationResNotifyBefore |
Notify before delivery (Destination Section) |
Does the receiving location require notification before pickup? |
Applies only if:
Must be: Y or N. |
destinationResLimitedAccess |
Limited access delivery (Destination Section) |
Does the receiving location have limited access? |
Applies only if:
Must be: Y or N. |
destinationResHeavyLift |
Heavy lift help (Destination Section) |
Will the item be a heavy lift? |
Applies only if:
Must be: Y or N. |
destinationResTailgateLifter |
Tailgate lifter (Destination Section) |
Does the receiving location required a tailgate lifter? |
Applies only if:
Must be: Y or N. |
originIs |
Origin Is (Origin Section) |
What type of location is sending the item. |
Applies only if itemMethod is Door to Door. |
originBusUnattended |
Unattended (Origin Section) |
Will the sending location be unattended? |
Applies only if:
Must be: Y or N. |
originBusDock |
Loading Dock (Origin Section) |
Does the sending location have a dock? |
Applies only if:
Must be: Y or N. |
originBusForklift |
Forklift (Origin Section) |
Does the sending location have forklift? |
Applies only if:
Must be: Y or N. |
originBusLoadingFacilities |
Loading Facilities (Origin Section) |
Does the sending location have loading facilities? |
Applies only if:
Must be: Y or N. |
originBusInside |
Inside delivery (Origin Section) |
Does the sending location require an inside pickup? |
Applies only if:
Must be: Y or N. |
originBusNotifyBefore |
Notify before delivery (Origin Section) |
Does the sending location require notification before pickup? |
Applies only if:
Must be: Y or N. |
originBusLimitedAccess |
Limited access delivery (Origin Section) |
Does the sending location have limited access? |
Applies only if:
Must be: Y or N. |
originBusHeavyLift |
Heavy lift help (Origin Section) |
Will the item be a heavy lift? |
Applies only if:
Must be: Y or N. |
originBusTailgateLifter |
Tailgate lifter (Origin Section) |
Does the sending location require a tailgate lifter? |
Applies only if:
Must be: Y or N. |
originBusContainerSwingLifter |
Container swing lifter (Origin Section) |
Does the sending location require a container swing lifter? |
Applies only if:
Must be: Y or N. |
originResUnattended |
Unattended (Origin Section) |
Will the sending location be unattended? |
Applies only if:
Must be: Y or N. |
originResInside |
Inside delivery (Origin Section) |
Does the sending location require an inside pickup? |
Applies only if:
Must be: Y or N. |
originResNotifyBefore |
Notify before delivery (Origin Section) |
Does the sending location require notification before pickup? |
Applies only if:
Must be: Y or N. |
originResLimitedAccess |
Limited access delivery (Origin Section) |
Does the sending location have limited access? |
Applies only if:
Must be: Y or N. |
originResHeavyLift |
Heavy lift help (Origin Section) |
Will the item be a heavy lift? |
Applies only if:
Must be: Y or N. |
originResTailgateLifter |
Tailgate lifter (Origin Section) |
Does the sending location required a tailgate lifter? |
Applies only if:
Must be: Y or N. |
Anytime Section
| Name | Displayed Title | Details | Limitations |
|---|---|---|---|
readyDate |
Ready Date |
What date is the item ready to be sent? |
A date specified using the international format defined by ISO 8601 (ie. International Standards Organisation – http://www.iso.org) which follows the numerical date system as follows: YYYY-MM-DD. |
readyTime |
Ready Time |
What time is the item ready to be sent? |
Must be: AM or PM. |
Origin Section
| Name | Displayed Title | Details | Limitations |
|---|---|---|---|
originContactName |
Contact Name |
A contact name for the location. |
maximum length 100 characters. |
originCompanyName |
Company Name |
The name of the company, if location is a business. |
maximum length 100 characters. |
originStreet |
Street |
The street details for the address. |
maximum length 100 characters. |
originSuburb |
Suburb |
The suburb for the address. |
Must match exactly (ie. letter for letter but not case sensitive) with the suburb name defined within the Temando system, which are extracted from the Postcode Datafile as provided by Australia Post (https://www.auspost.com.au). |
originState |
State |
The state for the address. |
Must be: QLD, NSW, VIC, ACT, SA, WA, NT or TAS. |
originCode |
Postal Code |
The postal code for the address. |
Must match exactly (ie. letter for letter but not case sensitive) with the postal codes defined within the Temando system, which are extracted from the Postcode Datafile as provided by Australia Post (https://www.auspost.com.au). |
originCountry |
Country |
The country for the address. |
Must be a 2 letter code representing a country as specified by ISO 3166 (ie. International Standards Organisation – http://www.iso.org). |
originPhone1 |
Phone 1 |
The first phone number for the address. |
maximum length 50 characters. |
originPhone2 |
Phone 2 |
The second phone number for the address. |
maximum length 50 characters. |
originFax |
Fax |
The fax number for the address. |
maximum length 50 characters. |
originEmail |
Email Address/es |
The email address for the address. |
maximum length 500 characters. |
Destination Section
| Name | Displayed Title | Details | Limitations |
|---|---|---|---|
destinationContactName |
Contact Name |
A contact name for the location. |
maximum length 100 characters. |
destinationCompanyName |
Company Name |
The name of the company, if location is a business. |
maximum length 100 characters. |
destinationStreet |
Street |
The street details for the address. |
maximum length 100 characters. |
destinationSuburb |
Suburb |
The suburb for the address. |
Must match exactly (ie. letter for letter but not case sensitive) with the suburb name defined within the Temando system, which are extracted from the Postcode Datafile as provided by Australia Post (https://www.auspost.com.au). |
destinationState |
State |
The state for the address. |
Must be: QLD, NSW, VIC, ACT, SA, WA, NT or TAS. |
destinationCode |
Postal Code |
The postal code for the address. |
Must match exactly (ie. letter for letter but not case sensitive) with the postal codes defined within the Temando system, which are extracted from the Postcode Datafile as provided by Australia Post (https://www.auspost.com.au). |
destinationCountry |
Country |
The country for the address. |
Must be a 2 letter code representing a country as specified by ISO 3166 (ie. International Standards Organisation – http://www.iso.org). |
destinationPhone1 |
Phone 1 |
The first phone number for the address. |
maximum length 50 characters. |
destinationPhone2 |
Phone 2 |
The second phone number for the address. |
maximum length 50 characters. |
destinationFax |
Fax |
The fax number for the address. |
maximum length 50 characters. |
destinationEmail |
Email Address/es |
The email address for the address. |
maximum length 500 characters. |