Lookup Web Service

Lookup

Click here for a complete list of operations.

getAddress

Queries the PAF® database, returning the address and premise information matching the postcode.
This service covers England, Northern Ireland, Scotland and Wales.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /lookup.asmx HTTP/1.1
Host: ws1.postcodesoftware.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://postcodesoftware.co.uk/getAddress"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getAddress xmlns="http://postcodesoftware.co.uk/">
      <account>string</account>
      <password>string</password>
      <postcode>string</postcode>
    </getAddress>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getAddressResponse xmlns="http://postcodesoftware.co.uk/">
      <getAddressResult>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <Address4>string</Address4>
        <Town>string</Town>
        <County>string</County>
        <Postcode>string</Postcode>
        <PremiseData>string</PremiseData>
        <ErrorNumber>short</ErrorNumber>
        <ErrorMessage>string</ErrorMessage>
      </getAddressResult>
    </getAddressResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /lookup.asmx HTTP/1.1
Host: ws1.postcodesoftware.co.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getAddress xmlns="http://postcodesoftware.co.uk/">
      <account>string</account>
      <password>string</password>
      <postcode>string</postcode>
    </getAddress>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getAddressResponse xmlns="http://postcodesoftware.co.uk/">
      <getAddressResult>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <Address4>string</Address4>
        <Town>string</Town>
        <County>string</County>
        <Postcode>string</Postcode>
        <PremiseData>string</PremiseData>
        <ErrorNumber>short</ErrorNumber>
        <ErrorMessage>string</ErrorMessage>
      </getAddressResult>
    </getAddressResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /lookup.asmx/getAddress?account=string&password=string&postcode=string HTTP/1.1
Host: ws1.postcodesoftware.co.uk

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Address xmlns="http://postcodesoftware.co.uk/">
  <Address1>string</Address1>
  <Address2>string</Address2>
  <Address3>string</Address3>
  <Address4>string</Address4>
  <Town>string</Town>
  <County>string</County>
  <Postcode>string</Postcode>
  <PremiseData>string</PremiseData>
  <ErrorNumber>short</ErrorNumber>
  <ErrorMessage>string</ErrorMessage>
</Address>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /lookup.asmx/getAddress HTTP/1.1
Host: ws1.postcodesoftware.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

account=string&password=string&postcode=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Address xmlns="http://postcodesoftware.co.uk/">
  <Address1>string</Address1>
  <Address2>string</Address2>
  <Address3>string</Address3>
  <Address4>string</Address4>
  <Town>string</Town>
  <County>string</County>
  <Postcode>string</Postcode>
  <PremiseData>string</PremiseData>
  <ErrorNumber>short</ErrorNumber>
  <ErrorMessage>string</ErrorMessage>
</Address>

Parameter	Value
account:
password:
postcode: