PostcodeEverywhere


Click here for a complete list of operations.

AddressLookupRaw

Takes either a postcode and optional property or a postkey and returns a single address record.
Raw PAF address data is returned to allow access to individual unformatted fields.

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/AddressLookupRaw"

<?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>
    <AddressLookupRaw 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>
    </AddressLookupRaw>
  </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>
    <AddressLookupRawResponse xmlns="http://ws.afd.co.uk/">
      <AddressLookupRawResult>
        <strOrganisation>string</strOrganisation>
        <strDepartment>string</strDepartment>
        <strNumber>string</strNumber>
        <strSubBuilding>string</strSubBuilding>
        <strBuilding>string</strBuilding>
        <strPOBox>string</strPOBox>
        <strDepStreet>string</strDepStreet>
        <strStreet>string</strStreet>
        <strDoubleDependantLocality>string</strDoubleDependantLocality>
        <strDependantLocality>string</strDependantLocality>
        <strTown>string</strTown>
        <strCounty>string</strCounty>
        <strPostcode>string</strPostcode>
        <strDPS>string</strDPS>
        <strMailsort>string</strMailsort>
        <strPostcodeType>string</strPostcodeType>
        <strHouseholdCount>string</strHouseholdCount>
        <strAuthority>string</strAuthority>
        <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>
        <strUDPRN>string</strUDPRN>
      </AddressLookupRawResult>
    </AddressLookupRawResponse>
  </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>
    <AddressLookupRaw 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>
    </AddressLookupRaw>
  </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>
    <AddressLookupRawResponse xmlns="http://ws.afd.co.uk/">
      <AddressLookupRawResult>
        <strOrganisation>string</strOrganisation>
        <strDepartment>string</strDepartment>
        <strNumber>string</strNumber>
        <strSubBuilding>string</strSubBuilding>
        <strBuilding>string</strBuilding>
        <strPOBox>string</strPOBox>
        <strDepStreet>string</strDepStreet>
        <strStreet>string</strStreet>
        <strDoubleDependantLocality>string</strDoubleDependantLocality>
        <strDependantLocality>string</strDependantLocality>
        <strTown>string</strTown>
        <strCounty>string</strCounty>
        <strPostcode>string</strPostcode>
        <strDPS>string</strDPS>
        <strMailsort>string</strMailsort>
        <strPostcodeType>string</strPostcodeType>
        <strHouseholdCount>string</strHouseholdCount>
        <strAuthority>string</strAuthority>
        <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>
        <strUDPRN>string</strUDPRN>
      </AddressLookupRawResult>
    </AddressLookupRawResponse>
  </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/AddressLookupRaw?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"?>
<AddressRaw xmlns="http://ws.afd.co.uk/">
  <strOrganisation>string</strOrganisation>
  <strDepartment>string</strDepartment>
  <strNumber>string</strNumber>
  <strSubBuilding>string</strSubBuilding>
  <strBuilding>string</strBuilding>
  <strPOBox>string</strPOBox>
  <strDepStreet>string</strDepStreet>
  <strStreet>string</strStreet>
  <strDoubleDependantLocality>string</strDoubleDependantLocality>
  <strDependantLocality>string</strDependantLocality>
  <strTown>string</strTown>
  <strCounty>string</strCounty>
  <strPostcode>string</strPostcode>
  <strDPS>string</strDPS>
  <strMailsort>string</strMailsort>
  <strPostcodeType>string</strPostcodeType>
  <strHouseholdCount>string</strHouseholdCount>
  <strAuthority>string</strAuthority>
  <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>
  <strUDPRN>string</strUDPRN>
</AddressRaw>

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/AddressLookupRaw 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"?>
<AddressRaw xmlns="http://ws.afd.co.uk/">
  <strOrganisation>string</strOrganisation>
  <strDepartment>string</strDepartment>
  <strNumber>string</strNumber>
  <strSubBuilding>string</strSubBuilding>
  <strBuilding>string</strBuilding>
  <strPOBox>string</strPOBox>
  <strDepStreet>string</strDepStreet>
  <strStreet>string</strStreet>
  <strDoubleDependantLocality>string</strDoubleDependantLocality>
  <strDependantLocality>string</strDependantLocality>
  <strTown>string</strTown>
  <strCounty>string</strCounty>
  <strPostcode>string</strPostcode>
  <strDPS>string</strDPS>
  <strMailsort>string</strMailsort>
  <strPostcodeType>string</strPostcodeType>
  <strHouseholdCount>string</strHouseholdCount>
  <strAuthority>string</strAuthority>
  <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>
  <strUDPRN>string</strUDPRN>
</AddressRaw>