Postcode Programming API  Get Long/Lat from JSON/JSONP Web Service using PostZon Data

To get a "Postzon" Geographical Data address from our JSON/JSONP Web Service we do the following:

Distance between two postcodes

The distance between two postcodes can be returned. Simply call with Postcode and “Home postcode” provided in the parameters. Our service will then return the distance in km.  So approximate charges could be applied to a customer based on the straight line distance.

Postcode to Longitude/Latitude

This is the main use of PostZon data. Simply call with the target Postcode and the PostZon data service will return the Longitude and Latitude. Ideal for mapping and calculating distances.

Longitude/Latitude to Postcode

To get the PostZon record by Longtitude/Latitude, (closest within 10Km) set postcode to the "Longtitude|Latitude" (separated by |). The Postcode found will be returned in pz_postcode.

Town to Longitude/Latitude

To get the Longitude and Latitude of a Town, simply provide the Town name + “,SPACE“ + County in the postcode field. The Longitude and Latitude will then be returned. It is suggested that the town list is displayed using a AJAX search box.

Get PostZon Data from JSON Web Service

To get a "Postzon" Geographical Data, including the distance between two postcodes, from our JSON Web Service we do the following:

Step 1 Sign up for free 30 day trial

Simply use the "Sign Up for Trial" link at top right of this page to open a trial account.   We will then send you a data key, which is used to identify your account, when using the following service.

Step 2 Call for PostZon record

Call josn Service/JSONSearchForPostZonData.aspx to get PostZon record. This call will retrieve the PostZon Data for a given Postcode, OSRef, Longtitude/Latitude or by Town. This PostZon data is collected from many different source by the Royal mail. The most useful information is Distance (in Km) from Home Postcode, Longitude and Latitude.

PostZon call Parameters

Parameter name Description
datakey Datakey, which is available when account has been created, under the “DataKey” tab of the online account administrator page.
username Only needed if for internal postcode address use
postcode Postcode to search for. OR...
To get the PostZon record by OSRef, simply set postcode to the OSRef.
To get the PostZon record by Longtitude/Latitude, (closest within 10Km) set postcode to the "Longtitude|Latitude" (separated by |). The Postcode found will be returned in pz_postcode.
To get the Longitude and Latitude of a Town, simply provide the Town name + “,SPACE“ + County in the postcode field. The Longitude and Latitude will then be returned. It is suggested that the town list is displayed using a AJAX search box.

[Download town list]
version Set 1, this allows us to change XML structure without effecting you software
ip IP Address of client. This is optional. We monitor address queries and have had cases where client’s web sites have been used repeatly by one person. Specifying the IP address of each client allows to monitor and block such queries.
homepostcode To calculate the distance to another postcode, supply the HOME postcode here, this is optional
jsoncallback JSONP callback function name
cross cross=true will allow cross orgin calls to overcome a CORS Error

More information on PostZon data, including detail information about the data returned.

Example

Call JSON web service with your data key, which is e-mail to you when you open an account, and postcode. 


          Web Service   
            
            www.simplylookupadmin.co.uk/JSONservice/JSONSearchForPostZonData.aspx?datakey=Your 
              Data Key&postcode=pe132ql&homepostcode=BS20 
              6EL
        
      

          Returns json   
            
            {

							"found":"1",

							"credits_display_text":"Evaluation expires 31 Mar 
							2011",

							"accountadminpage":"https://www.simplylookupadmin.co.uk/WebAccountLogin.aspx?

                                         
							doid=1&coid=3333366462&Pay=yes",

							"errormessage":"",

							"pz_introductiondate":"19880254",

							"pz_gridrefeast":"54630",

							"pz_gridrefnorth":"30910",

							"pz_county":"12,Cambridgeshire",

							"pz_district":"UD,Fenland District",

							"pz_ward":"GT,Medworth Ward",

							"pz_usertype":"0,Small User",

							"pz_gridstatus":"1,Within building",

							"pz_country":"064,England",

							"pz_wardstatus":"1",

							"pz_nhs_code":"Q35,East of England",

							"pz_nhs_region":"Y51,",

							"pz_latitude_wgs84":"52.659857",

							"pz_longitude_wgs84":"0.1617",

							"pz_osreference":"TF4630009100",

							"pz_geodistancetohomepostcode":"239",

							"pz_postcode":"PE132QL"

							}

If address returned then found = 1, else found = 0,error in errormessage

errormessage should be displayed if populated

  Note: The pz_geodistancetohomepostcode element contains the distance between:

  • &postcode=PE132QL
  • &homepostcode=BS20 6EL

Expressed in the parameters. If the optional &homepostcode parameter is omitted then this will be 0.

Step 3 Testing

Final step is to test, to enable easy testing please use our special test postcodes.

Data Returned

This type of license returns:

  • pz_postcode
  • pz_found
  • pz_geodistancetohomepostcode (Distance from "Home Postcode" in km)
  • pz_latitude_wgs84
  • pz_longitude_wgs84
  • pz_gridstatus  (accuracy of the geographic data)
  • pz_osreference       

More infromation on returned Geographic data