Postcode Programming API  Get Full Address from HTTP/XML Web Service

Full Address Search functionality:

  1. Enter postcode to search for
  2. Presents a list of addresses at postcode entered
  3. Address is selected by user
  4. Full address for selection is returned

To get a full address from our HTTP/XML 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 Web Service for list of address at Postcode

Call XMLService/XMLSearchForAddress.aspx for list of address at Postcode

Returns a series of lines, from which the user can select full royal mail address information (Royal mail PAF Database). XMLGetAddressRecord.aspx (Step 2) is then called with the selected address id, to get full address information.

Parameters

Parameter name Description
DataKey Datakey, which is available when account has been created, under the “DataKey” tab of the online account administrator page.
version Set 1, this allows to change XML structure without effecting you software
Username Only needed if for internal postcode address use
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.

 

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
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
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 (step 3)
line Address line to display for selection, used in next part of search

 

Example HTTP call

 

Call HTTP web service with your data key, which is e-mailed to you when you open an account.  The data key identifies your account and licenses in our system.

 

                  Web Service   
                    
                    www.simplylookupadmin.co.uk/XMLservice/XMLSearchForAddress.aspx?datakey=Your Data Key&postcode=pe132ql
                
              


 

 

      Returns XML   
      
        
      


    
    
    
   


   
      
       
      

      
          
         
]>


   1
   
   http://xxx...xxx
   1/1 users 

   
      0
      2

      
         
            11570840_0e
            
        44 Victoria Road Wisbech
         
         
            11570841_0e
            
        48 Victoria Road Wisbech
         
      

   

    
  

 

 

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:

 

        Web Service   
          
          www.simplylookupadmin.co.uk/XMLservice/XMLSearchForAddress.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 3 Call XMLService/XMLGetAddressRecord.aspx Get Address Record

Gets the full address information given the ID.  Now call to get the full address record information for the address line selected by user.

Parameters

Parameter name Description
DataKey Datakey, which is available when account has been created, under the “DataKey” tab of the online account administrator page.
version Set 2, this allows us to change XML structure without effecting you software
Username Only needed if for internal postcode address use
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.
id Record ID, to identify the Royal mail address record. Royal mail PAF File

 

Returns

 

Parameter name Description
data Data regarding the status of the account.  Documented in Step 2 above.
record Full Address information

 

Element : “data”:

 

See section below on data returned

Example Code

Call HTTP web service with your data key.

 

        Web Service   
          
          www.simplylookupadmin.co.uk/XMLservice/XMLGetAddressRecord.aspx?datakey=Your Data Key&id=11570840_0E&version=2
      
    

 

 

        Returns XML   
          

    

    
    
    
   
                  rawpostcode, deliverypointsuffix,nohouseholds, smallorg, pobox, mailsortcode,
               udprn,unique, spare )>
       
       
       
       
       
       
       
       
       
       
       
       
       
       
      ]>
      
      
       
   

   1
   Evaluation expires 28 Jul 2010
   https:/...
   

   
11570840_0E

            Comtek
      44 Victoria Road
      
      
      Wisbech
      Cambridgeshire
      PE13 2QL
      England
      2N
      1
      N
      
      PE132QL
      18962
      19147292
      44

            44||Victoria Road|||
   


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

 

 

Step 4 Get Address record based on record select

 

When the users selects a record then simply get it using the sames call as in step 3 of the "Full Address" search


Data Returned

This type of license returns: (see example below)

  • id
  • organisation (Company name)
  • line1
  • line2
  • line3
  • town
  • county
  • postcode
  • country. "England","Wales","Northern Ireland","Isle of Man","Channel Islands","Scotland"
  • mailsortcode
  • unique
  • deliverypointsuffix
  • nohouseholds
  • udprn   (Royal mail unique id for each address)
  • rawpostcode (formated postcode 7 chars long)
  • Spare

see Additional Data Returned by Postcode Finder API for more information