Get Thoroughfare/Street from JSON Web Service:
Thoroughfare/Street Address Search functionality:
- Postcode is enteredby user, to search for
- User presses Search button
- Address returned apart from House Name and Number
- User enters House Name and Number manually in seperate field, unlike Full Address
To get a Thoroughfare/Street address from our JSON Web Service we do the following:
Step 1 Sign up for 30 day free 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 JSONService/JSONSearchForThoroughfareAddress.aspx to get address record
This call will retrieve the Thoroughfare Address Data, from the Royal Mail Thoroughfare PAF database, for a given Postcode. The Thoroughfare Address is a cut down version of the Full Address, basically it does not contain the Building name or number. Therefore the programmer should allow the user to enter the House Name/Number for the address. These licenses are cheaper than Full Postcode data.
|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|
|version||Set 1, this allows us to change JSON 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.|
|Postcode||Postcode to search for|
To retrieve residential property only. To do this simply append “[” to the end of the Postcode.
To retrieve commercial property only. To do this simply append “]” to the end of the Postcode.
|data||Data regarding the status of the account|
|errormessage||Contains a message if error occurred when searching for Address by Postcode|
|accountadminpage||URL for page to buy more Postcode Address licenses|
|credits_display_text||Status of Postcode Address licenses. This shows the number of users/credit lookups available|
|found||Equals “1” if data has been returned, thus process records below|
|Address fields||Address information. See "Data returned" section below|
Call JSON web service with your data key, which is e-mailed to you when you open an account, and postcode. The data key identifies your account and licenses.
www.simplylookupadmin.co.uk/JSONservice/JSONSearchForPostZonData.aspx?datakey=Your Data Key&postcode=pe132ql
If address returned then <found>=1, else <found>=0,error in <errormessage>
<errormessage> should be displayed if populated.
If used by employee of company (classed as "Internal use")
It is a requirement of the royal mail that if postcode lookup software is used by an employee of a company, then the user must be uniquely identified so we can apply a user count.
Therefore the URL must contain a User ID:
www.simplylookupadmin.co.uk/JSONservice/JSONSearchForPostZonData.aspx?datakey=Your Data Key&postcode=pe132ql&username=UserID
This will be the datakey beginning with "I"
Section 3.5 of the Terms and Conditions state: "The Customer, when using the Postcode Lookup service via Web Service, must make sure each user is identified by a unique Computer name, in each call to the Web Service if used internally”. In simple language this means that each user must be identified by a unique computer name, in username parameter, if used by a company employee.
Step 4 Testing
Final step is to test, to enable easy testing please use our special test postcodes.