PostcodeEverywhere


Click here for a complete list of operations.

AddressSearch

Takes search parameters for some or all fields of the address and returns a list of matching addresses.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
strSerialNumber:
strPassword:
strUserID:
strOrganisation:
strProperty:
strStreet:
strLocality:
strTown:
strPostcodeFrom:
strPostcodeTo:
strCounty:
strCountyType:

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 /PCE_WebService.asmx HTTP/1.1
Host: ws.afd.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.afd.co.uk/AddressSearch"

<?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>
    <AddressSearch xmlns="http://ws.afd.co.uk/">
      <strSerialNumber>string</strSerialNumber>
      <strPassword>string</strPassword>
      <strUserID>string</strUserID>
      <strOrganisation>string</strOrganisation>
      <strProperty>string</strProperty>
      <strStreet>string</strStreet>
      <strLocality>string</strLocality>
      <strTown>string</strTown>
      <strPostcodeFrom>string</strPostcodeFrom>
      <strPostcodeTo>string</strPostcodeTo>
      <strCounty>string</strCounty>
      <strCountyType>string</strCountyType>
    </AddressSearch>
  </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>
    <AddressSearchResponse xmlns="http://ws.afd.co.uk/">
      <AddressSearchResult>
        <intTotalRecordsFound>int</intTotalRecordsFound>
        <lstAddresses>
          <string>string</string>
          <string>string</string>
        </lstAddresses>
        <lstPostkeys>
          <string>string</string>
          <string>string</string>
        </lstPostkeys>
      </AddressSearchResult>
    </AddressSearchResponse>
  </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 /PCE_WebService.asmx HTTP/1.1
Host: ws.afd.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>
    <AddressSearch xmlns="http://ws.afd.co.uk/">
      <strSerialNumber>string</strSerialNumber>
      <strPassword>string</strPassword>
      <strUserID>string</strUserID>
      <strOrganisation>string</strOrganisation>
      <strProperty>string</strProperty>
      <strStreet>string</strStreet>
      <strLocality>string</strLocality>
      <strTown>string</strTown>
      <strPostcodeFrom>string</strPostcodeFrom>
      <strPostcodeTo>string</strPostcodeTo>
      <strCounty>string</strCounty>
      <strCountyType>string</strCountyType>
    </AddressSearch>
  </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>
    <AddressSearchResponse xmlns="http://ws.afd.co.uk/">
      <AddressSearchResult>
        <intTotalRecordsFound>int</intTotalRecordsFound>
        <lstAddresses>
          <string>string</string>
          <string>string</string>
        </lstAddresses>
        <lstPostkeys>
          <string>string</string>
          <string>string</string>
        </lstPostkeys>
      </AddressSearchResult>
    </AddressSearchResponse>
  </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 /PCE_WebService.asmx/AddressSearch?strSerialNumber=string&strPassword=string&strUserID=string&strOrganisation=string&strProperty=string&strStreet=string&strLocality=string&strTown=string&strPostcodeFrom=string&strPostcodeTo=string&strCounty=string&strCountyType=string HTTP/1.1
Host: ws.afd.co.uk

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

<?xml version="1.0" encoding="utf-8"?>
<AddressResultsList xmlns="http://ws.afd.co.uk/">
  <intTotalRecordsFound>int</intTotalRecordsFound>
  <lstAddresses>
    <string>string</string>
    <string>string</string>
  </lstAddresses>
  <lstPostkeys>
    <string>string</string>
    <string>string</string>
  </lstPostkeys>
</AddressResultsList>

HTTP POST

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

POST /PCE_WebService.asmx/AddressSearch HTTP/1.1
Host: ws.afd.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

strSerialNumber=string&strPassword=string&strUserID=string&strOrganisation=string&strProperty=string&strStreet=string&strLocality=string&strTown=string&strPostcodeFrom=string&strPostcodeTo=string&strCounty=string&strCountyType=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AddressResultsList xmlns="http://ws.afd.co.uk/">
  <intTotalRecordsFound>int</intTotalRecordsFound>
  <lstAddresses>
    <string>string</string>
    <string>string</string>
  </lstAddresses>
  <lstPostkeys>
    <string>string</string>
    <string>string</string>
  </lstPostkeys>
</AddressResultsList>