JavaScript postcode/address finder class - user guide

This is a generic user guide to using our JavaScript. As standard the JavaScript class allows easy integration of RapidAddress and FlexiAddress into any HTML page. Feel free to contact us should you need any help with integration.

The class

Code for the class can be downloaded from the downloads section.

If using the compressed version of the class, charset needs to be set to "ISO-8859-1", eg:

<script type="text/javascript" charset="ISO-8859-1" src="crafty_postcode.class.js">
</script>

Configuration

To create and configure a JavaScript object:

<script>
  var cp_obj = CraftyPostcodeCreate();
  cp_obj.set("access_token", "xxxxx-xxxxx-xxxxx-xxxxx"); // your token here
  
  cp_obj.set("option_1", "value_1");
	...
  cp_obj.set("option_n", "value_n");
</script>

If you want to use address lookup more than once on a page, you can create multiple objects. Each object can be used independently of the others :

  var cp_obj_1 = CraftyPostcodeCreate();
	....
  var cp_obj_n = CraftyPostcodeCreate();

Available options:

Configuring the address form

There are two methods to tell the object where to find the address form fields:

• Tell the script the name of the form and the names of the fields.
• Attach unique IDs to all the fields.

Method 1:

<script>
  cp_obj.set("form"          , "XYZ");
  cp_obj.set("elem_company"  , "companyname");
  cp_obj.set("elem_street1"  , "address1");
  //... etc ...
</script>

Method 2:

Add id="*_id" to every <input> field.

<script>
  cp_obj.set("form", "");
  cp_obj.set("elem_company"  , "companyname_id");
  cp_obj.set("elem_street1"  , "address1_id");
  //... etc ...
</script>

Minimum configuration:

Not all address fields need to be set, the minimum set would be:

  cp_obj.set("elem_company"  , "");
  cp_obj.set("elem_street1"  , "address1");
  cp_obj.set("elem_street2"  , "");
  cp_obj.set("elem_street3"  , "");
  cp_obj.set("elem_town"     , "town");
  cp_obj.set("elem_county"   , "");
  cp_obj.set("elem_postcode" , "postcode");
  cp_obj.set("elem_house_num", ""); 

Debugging

If things don't work right away, set the object into debug mode and see if the error messages give any clues:

  cp_obj.set("debug_mode",   "1");

If you still have no luck - email any error codes/messages to us. We will be happy to help.