PostcodeEverywhere


Click here for a complete list of operations.

AddressLookup

Takes either a postcode and optional property or a postkey and returns a single address record.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
strSerialNumber:
strPassword:
strUserID:
strPostcode:
strProperty:
strPostkey:
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/AddressLookup"

<?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>
    <AddressLookup xmlns="http://ws.afd.co.uk/">
      <strSerialNumber>string</strSerialNumber>
      <strPassword>string</strPassword>
      <strUserID>string</strUserID>
      <strPostcode>string</strPostcode>
      <strProperty>string</strProperty>
      <strPostkey>string</strPostkey>
      <strCountyType>string</strCountyType>
    </AddressLookup>
  </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>
    <AddressLookupResponse xmlns="http://ws.afd.co.uk/">
      <AddressLookupResult>
        <strOrganisation>string</strOrganisation>
        <strProperty>string</strProperty>
        <strStreet>string</strStreet>
        <strLocality>string</strLocality>
        <strTown>string</strTown>
        <strCounty>string</strCounty>
        <strPostcode>string</strPostcode>
        <strDPS>string</strDPS>
        <strMailsort>string</strMailsort>
        <strPostcodeType>string</strPostcodeType>
        <strHouseholdCount>string</strHouseholdCount>
        <strAuthority>string</strAuthority>
        <strAuthorityCode>string</strAuthorityCode>
        <strConstituency>string</strConstituency>
        <strTVRegion>string</strTVRegion>
        <strGridEast>string</strGridEast>
        <strGridNorth>string</strGridNorth>
        <strLatitude>string</strLatitude>
        <strLongitude>string</strLongitude>
        <strSTDCode>string</strSTDCode>
        <strWardCode>string</strWardCode>
        <strWardName>string</strWardName>
        <strNHSCode>string</strNHSCode>
        <strNHSName>string</strNHSName>
        <strNHSRegion>string</strNHSRegion>
        <strNHSRegionCode>string</strNHSRegionCode>
        <strChanged>string</strChanged>
        <strCensusCode>string</strCensusCode>
        <strAffluence>string</strAffluence>
        <strLifeStage>string</strLifeStage>
        <strAdditionalCensusInfo>string</strAdditionalCensusInfo>
        <strOccupancy>string</strOccupancy>
        <strOccupancyDescription>string</strOccupancyDescription>
        <strAddressType>string</strAddressType>
        <strAddressTypeDescription>string</strAddressTypeDescription>
        <strPCTCode>string</strPCTCode>
        <strPCTName>string</strPCTName>
        <strEERCode>string</strEERCode>
        <strEERName>string</strEERName>
        <strUrbanRuralCode>string</strUrbanRuralCode>
        <strUrbanRuralName>string</strUrbanRuralName>
        <strLEACode>string</strLEACode>
        <strLEAName>string</strLEAName>
        <strUDPRN>string</strUDPRN>
      </AddressLookupResult>
    </AddressLookupResponse>
  </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>
    <AddressLookup xmlns="http://ws.afd.co.uk/">
      <strSerialNumber>string</strSerialNumber>
      <strPassword>string</strPassword>
      <strUserID>string</strUserID>
      <strPostcode>string</strPostcode>
      <strProperty>string</strProperty>
      <strPostkey>string</strPostkey>
      <strCountyType>string</strCountyType>
    </AddressLookup>
  </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>
    <AddressLookupResponse xmlns="http://ws.afd.co.uk/">
      <AddressLookupResult>
        <strOrganisation>string</strOrganisation>
        <strProperty>string</strProperty>
        <strStreet>string</strStreet>
        <strLocality>string</strLocality>
        <strTown>string</strTown>
        <strCounty>string</strCounty>
        <strPostcode>string</strPostcode>
        <strDPS>string</strDPS>
        <strMailsort>string</strMailsort>
        <strPostcodeType>string</strPostcodeType>
        <strHouseholdCount>string</strHouseholdCount>
        <strAuthority>string</strAuthority>
        <strAuthorityCode>string</strAuthorityCode>
        <strConstituency>string</strConstituency>
        <strTVRegion>string</strTVRegion>
        <strGridEast>string</strGridEast>
        <strGridNorth>string</strGridNorth>
        <strLatitude>string</strLatitude>
        <strLongitude>string</strLongitude>
        <strSTDCode>string</strSTDCode>
        <strWardCode>string</strWardCode>
        <strWardName>string</strWardName>
        <strNHSCode>string</strNHSCode>
        <strNHSName>string</strNHSName>
        <strNHSRegion>string</strNHSRegion>
        <strNHSRegionCode>string</strNHSRegionCode>
        <strChanged>string</strChanged>
        <strCensusCode>string</strCensusCode>
        <strAffluence>string</strAffluence>
        <strLifeStage>string</strLifeStage>
        <strAdditionalCensusInfo>string</strAdditionalCensusInfo>
        <strOccupancy>string</strOccupancy>
        <strOccupancyDescription>string</strOccupancyDescription>
        <strAddressType>string</strAddressType>
        <strAddressTypeDescription>string</strAddressTypeDescription>
        <strPCTCode>string</strPCTCode>
        <strPCTName>string</strPCTName>
        <strEERCode>string</strEERCode>
        <strEERName>string</strEERName>
        <strUrbanRuralCode>string</strUrbanRuralCode>
        <strUrbanRuralName>string</strUrbanRuralName>
        <strLEACode>string</strLEACode>
        <strLEAName>string</strLEAName>
        <strUDPRN>string</strUDPRN>
      </AddressLookupResult>
    </AddressLookupResponse>
  </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/AddressLookup?strSerialNumber=string&strPassword=string&strUserID=string&strPostcode=string&strProperty=string&strPostkey=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"?>
<Address xmlns="http://ws.afd.co.uk/">
  <strOrganisation>string</strOrganisation>
  <strProperty>string</strProperty>
  <strStreet>string</strStreet>
  <strLocality>string</strLocality>
  <strTown>string</strTown>
  <strCounty>string</strCounty>
  <strPostcode>string</strPostcode>
  <strDPS>string</strDPS>
  <strMailsort>string</strMailsort>
  <strPostcodeType>string</strPostcodeType>
  <strHouseholdCount>string</strHouseholdCount>
  <strAuthority>string</strAuthority>
  <strAuthorityCode>string</strAuthorityCode>
  <strConstituency>string</strConstituency>
  <strTVRegion>string</strTVRegion>
  <strGridEast>string</strGridEast>
  <strGridNorth>string</strGridNorth>
  <strLatitude>string</strLatitude>
  <strLongitude>string</strLongitude>
  <strSTDCode>string</strSTDCode>
  <strWardCode>string</strWardCode>
  <strWardName>string</strWardName>
  <strNHSCode>string</strNHSCode>
  <strNHSName>string</strNHSName>
  <strNHSRegion>string</strNHSRegion>
  <strNHSRegionCode>string</strNHSRegionCode>
  <strChanged>string</strChanged>
  <strCensusCode>string</strCensusCode>
  <strAffluence>string</strAffluence>
  <strLifeStage>string</strLifeStage>
  <strAdditionalCensusInfo>string</strAdditionalCensusInfo>
  <strOccupancy>string</strOccupancy>
  <strOccupancyDescription>string</strOccupancyDescription>
  <strAddressType>string</strAddressType>
  <strAddressTypeDescription>string</strAddressTypeDescription>
  <strPCTCode>string</strPCTCode>
  <strPCTName>string</strPCTName>
  <strEERCode>string</strEERCode>
  <strEERName>string</strEERName>
  <strUrbanRuralCode>string</strUrbanRuralCode>
  <strUrbanRuralName>string</strUrbanRuralName>
  <strLEACode>string</strLEACode>
  <strLEAName>string</strLEAName>
  <strUDPRN>string</strUDPRN>
</Address>

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/AddressLookup HTTP/1.1
Host: ws.afd.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

strSerialNumber=string&strPassword=string&strUserID=string&strPostcode=string&strProperty=string&strPostkey=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"?>
<Address xmlns="http://ws.afd.co.uk/">
  <strOrganisation>string</strOrganisation>
  <strProperty>string</strProperty>
  <strStreet>string</strStreet>
  <strLocality>string</strLocality>
  <strTown>string</strTown>
  <strCounty>string</strCounty>
  <strPostcode>string</strPostcode>
  <strDPS>string</strDPS>
  <strMailsort>string</strMailsort>
  <strPostcodeType>string</strPostcodeType>
  <strHouseholdCount>string</strHouseholdCount>
  <strAuthority>string</strAuthority>
  <strAuthorityCode>string</strAuthorityCode>
  <strConstituency>string</strConstituency>
  <strTVRegion>string</strTVRegion>
  <strGridEast>string</strGridEast>
  <strGridNorth>string</strGridNorth>
  <strLatitude>string</strLatitude>
  <strLongitude>string</strLongitude>
  <strSTDCode>string</strSTDCode>
  <strWardCode>string</strWardCode>
  <strWardName>string</strWardName>
  <strNHSCode>string</strNHSCode>
  <strNHSName>string</strNHSName>
  <strNHSRegion>string</strNHSRegion>
  <strNHSRegionCode>string</strNHSRegionCode>
  <strChanged>string</strChanged>
  <strCensusCode>string</strCensusCode>
  <strAffluence>string</strAffluence>
  <strLifeStage>string</strLifeStage>
  <strAdditionalCensusInfo>string</strAdditionalCensusInfo>
  <strOccupancy>string</strOccupancy>
  <strOccupancyDescription>string</strOccupancyDescription>
  <strAddressType>string</strAddressType>
  <strAddressTypeDescription>string</strAddressTypeDescription>
  <strPCTCode>string</strPCTCode>
  <strPCTName>string</strPCTName>
  <strEERCode>string</strEERCode>
  <strEERName>string</strEERName>
  <strUrbanRuralCode>string</strUrbanRuralCode>
  <strUrbanRuralName>string</strUrbanRuralName>
  <strLEACode>string</strLEACode>
  <strLEAName>string</strLEAName>
  <strUDPRN>string</strUDPRN>
</Address>