|
Simply Postcode Lookup XML/ HTTP service
offer a simple way to interact with our postcode address lookup
service.
This service provides up to date Royal mail address information.
The service is available across a simple
HTTP protocol. Each request is a standard HTTP GET request
with the query string forming the request parameters.
Functions Available:
Search for FULL PAF
Address from Postcode
Get for Thoroughfare
Address from Postcode
Get PostZon Data from
Postcode
[What
is Full, Thoroughfare
and PostZon Data?]
Search for FULL PAF
Address from Postcode
XMLService/SearchForAddress.aspx
Returns
a series of lines, from which the user can select full royal mail
address information (Royal mail PAF Database). SearchForAddress.aspx
is then called with the selected address id, to get full address information.
Parameters:
|
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
|
All
parameters must be in lower case
Returns:
|
Name
|
Description
|
|
data
|
Data regarding the status of the account
|
|
addressdata
|
Address information
|
Element : “data”:
|
Name
|
Description
|
|
errormessage
|
Contains a message if error occurred when
searching for Address by Postcode
|
|
buymorecredits
|
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
|
|
confirm
|
Equals “Yes” if data has been
returned, thus process records below
|
|
addressdata
|
Contains address
|
|
|
|
Element : “addressdata”:
|
Name
|
Description
|
|
recordcount
|
Count of records returned
|
|
records
|
A series of records, for selection by
user.
Each has a unique Identifier
|
Element : “record”:
|
Name
|
Description
|
|
id
|
ID of address line to later call for
compete address
|
|
line
|
Address line to display for selection
|
Example:
www.simplylookupadmin.co.uk/xmlservice/SearchForAddress.aspx?datakey=xxxx
&postcode=pe132ql
Returns:
<Data>
<ErrorMessage></ErrorMessage>
<Confirm>Yes</Confirm>
<DemoON>0</DemoON>
<BuyMoreCredits>http://xxx...xxx</BuyMoreCredits>
<Credits_Display_Text>1/1 users, Small 4,946 Credits</Credits_Display_Text>
</Data>
<AddressData>
<maxresults>0</maxresults>
<recordcount>40</recordcount>
<records>
<record>
<id>11570840_0S_F</id>
<Line>44 Victoria Road Wisbech</Line>
</record>
<record>
<id>11570841_0S_F</id>
<Line>48 Victoria Road Wisbech</Line>
</record>
</records>
<Charged>1</Charged>
</AddressData>
XMLService/GetAddressRecord.aspx
Gets the full address information given the ID
Parameters:
|
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
|
|
id
|
Record ID, to identify the Royal mail
address record. Royal mail PAF File
|
All
parameters must be in lower case
Returns:
|
Name
|
Description
|
|
data
|
Data regarding the status of the account
|
|
record
|
Full Address information
|
Element : “data”:
Example:
www.simplylookupadmin.co.uk/xmlservice/GetAddressRecord.aspx?datakey=xxxx
&id=11570840_0S_F
Returns:
<data>
<confirm>Yes</confirm>
<credits_display_text>Small 1/1 users</credits_display_text>
<buymorecredits>http://xxx...xxx</buymorecredits>
<record>
<id>11570840_0S</id>
<organisation></organisation>
<line1>87 Victoria Road</line1>
<line2></line2>
<line3></line3>
<town>Wisbech</town>
<county>Cambridgeshire</county>
<postcode>PE13 2QL</postcode>
<country>England</country>
<deliverypointsuffix>2N</deliverypointsuffix>
<nohouseholds>1</nohouseholds>
<smallorg>N</smallorg>
<pobox></pobox>
<rawpostcode>PE132QL</rawpostcode>
</record>
</data>
Get for Thoroughfare
Address from Postcode
XMLService/SearchForThoroughfareAddress.aspx
This call will retrieve the Thoroughfare Address Data (Royal Mail
Thoroughfare PAF) 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 the Full Postcode data.
[What
is Full, Thoroughfare
and PostZon Data?]
Parameters:
|
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
|
All
parameters must be in lower case
Returns:
|
Name
|
Description
|
|
data
|
Data regarding the status of the account
|
|
record
|
Address fields. Some fields may be
blank.
|
Example:
www.simplylookupadmin.co.uk/xmlservice/SearchForThoroughfareAddress.aspx?datakey=xxxx
&postcode=pe132ql&username=administrator
Returns:
<data>
<confirm>Yes</confirm>
<credits_display_text>Thoroughfare 1/1 users</credits_display_text>
<buymorecredits>xxx...xxx</buymorecredits>
<record>
<id>11570811_0S</id>
<organisation></organisation>
<line1>Vicrotia Rd</line1>
<line2></line2>
<line3></line3>
<town>Wisbech</town>
<county>Cambridgeshire</county>
<postcode>PE13 2QL</postcode>
<country>England</country>
<deliverypointsuffix>1A</deliverypointsuffix>
<nohouseholds>1</nohouseholds>
<smallorg>N</smallorg>
<pobox></pobox>
<rawpostcode>PE132QL</rawpostcode>
</record>
</data>
Get PostZon Data
from Postcode
XMLService/SearchForPostZonData.aspx
This call will retrieve the PostZon Data for a given Postcode.
This PostZon data is collected from many different source by the
Royal mail.
[What
is Full, Thoroughfare
and PostZon Data?]
Parameters:
|
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
|
| homepostcode |
To calulate the distance to another postcode,
supply the HOME postcode here, this is optional |
All
parameters must be in lower case
Returns:
|
Name
|
Description
|
|
data
|
Data regarding the status of the account
|
|
record
|
Address information
|
Element : “record”:
|
Name
|
Description
|
|
pz_introductiondate
|
Date
introduced to file |
|
pz_gridrefeast
|
|
|
pz_gridrefnorth
|
|
|
pz_county
|
|
|
pz_district |
|
|
pz_ward
|
|
|
pz_usertype |
|
|
pz_gridstatus
|
|
|
pz_country |
|
|
pz_wardstatus
|
|
|
pz_nhs_code
|
|
|
pz_nhs_region |
|
|
pz_latitude_wgs84
|
Latitude
|
|
pz_longitude_wgs84
|
Longitude
|
|
pz_osreference
|
OS Referance
|
|
pz_wardstatus
|
|
|
pz_geodistancetohomepostcode
|
Distance from HOME postcode
|
|
pz_mailsort
|
Mailsort code
|
Example:
www.simplylookupadmin.co.uk/xmlservice/SearchForPostZonData.aspx?datakey=xxxx
&postcode=pe132ql&username=administrator
Returns:
<data>
<confirm>Yes</confirm>
<credits_display_text>PostZon 1/1 users</credits_display_text>
<buymorecredits>xxx...xxx</buymorecredits>
<record>
<pz_introductiondate>19981231</pz_introductiondate>
<pz_gridrefeast>31830</pz_gridrefeast>
<pz_gridrefnorth>17610</pz_gridrefnorth>
<pz_county>00</pz_county>
<pz_district>PT</pz_district>
<pz_ward>NK</pz_ward>
<pz_usertype>0</pz_usertype>
<pz_gridstatus>2</pz_gridstatus>
<pz_country>220</pz_country>
<pz_wardstatus>1</pz_wardstatus>
<pz_nhs_code>Q99</pz_nhs_code>
<pz_nhs_region>W00</pz_nhs_region>
<pz_latitude_wgs84>12.13</pz_latitude_wgs84>
<pz_longitude_wgs84>12.13</pz_longitude_wgs84>
<pz_osreference></pz_osreference>
<pz_geodistancetohomepostcode>3</pz_geodistancetohomepostcode>
<pz_mailsort>32911</pz_mailsort>
</record>
</data>
|
Log
In
