AddressFinder


Click here for a complete list of operations.

SearchPostcode

This function is used to return a SummaryAddresses Collection object when searching on the Postcode field.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sPostcode:
sAccountName:
sGUID:
sIPAddress:

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 /uk/addressfinder.asmx HTTP/1.1
Host: ws2.epostcode.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.epostcode.com/uk/SearchPostcode"

<?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>
    <SearchPostcode xmlns="http://ws.epostcode.com/uk/">
      <sPostcode>string</sPostcode>
      <sAccountName>string</sAccountName>
      <sGUID>string</sGUID>
      <sIPAddress>string</sIPAddress>
    </SearchPostcode>
  </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>
    <SearchPostcodeResponse xmlns="http://ws.epostcode.com/uk/">
      <SearchPostcodeResult>
        <IsError>boolean</IsError>
        <ErrorMessage>string</ErrorMessage>
        <List>
          <SummaryAddress>
            <IsError>boolean</IsError>
            <ErrorMessage>string</ErrorMessage>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <Locality>string</Locality>
            <DepartmentName>string</DepartmentName>
            <SubBuildingName>string</SubBuildingName>
            <Street>string</Street>
            <PostTown>string</PostTown>
            <PostCode>string</PostCode>
            <Organisation>string</Organisation>
            <Number>string</Number>
            <County>string</County>
            <BuildingName>string</BuildingName>
            <AbsRecNum>string</AbsRecNum>
            <FullAddress>string</FullAddress>
            <ListAddress>string</ListAddress>
            <DependentStreet>string</DependentStreet>
            <DoubleDependentLocality>string</DoubleDependentLocality>
            <GridEasting>string</GridEasting>
            <GridNorthing>string</GridNorthing>
            <PostOfficeBox>string</PostOfficeBox>
            <UserCategory>string</UserCategory>
            <DeliveryPointSuffix>string</DeliveryPointSuffix>
            <DeliveryPointNumber>int</DeliveryPointNumber>
          </SummaryAddress>
          <SummaryAddress>
            <IsError>boolean</IsError>
            <ErrorMessage>string</ErrorMessage>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <Locality>string</Locality>
            <DepartmentName>string</DepartmentName>
            <SubBuildingName>string</SubBuildingName>
            <Street>string</Street>
            <PostTown>string</PostTown>
            <PostCode>string</PostCode>
            <Organisation>string</Organisation>
            <Number>string</Number>
            <County>string</County>
            <BuildingName>string</BuildingName>
            <AbsRecNum>string</AbsRecNum>
            <FullAddress>string</FullAddress>
            <ListAddress>string</ListAddress>
            <DependentStreet>string</DependentStreet>
            <DoubleDependentLocality>string</DoubleDependentLocality>
            <GridEasting>string</GridEasting>
            <GridNorthing>string</GridNorthing>
            <PostOfficeBox>string</PostOfficeBox>
            <UserCategory>string</UserCategory>
            <DeliveryPointSuffix>string</DeliveryPointSuffix>
            <DeliveryPointNumber>int</DeliveryPointNumber>
          </SummaryAddress>
        </List>
      </SearchPostcodeResult>
    </SearchPostcodeResponse>
  </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 /uk/addressfinder.asmx HTTP/1.1
Host: ws2.epostcode.com
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>
    <SearchPostcode xmlns="http://ws.epostcode.com/uk/">
      <sPostcode>string</sPostcode>
      <sAccountName>string</sAccountName>
      <sGUID>string</sGUID>
      <sIPAddress>string</sIPAddress>
    </SearchPostcode>
  </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>
    <SearchPostcodeResponse xmlns="http://ws.epostcode.com/uk/">
      <SearchPostcodeResult>
        <IsError>boolean</IsError>
        <ErrorMessage>string</ErrorMessage>
        <List>
          <SummaryAddress>
            <IsError>boolean</IsError>
            <ErrorMessage>string</ErrorMessage>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <Locality>string</Locality>
            <DepartmentName>string</DepartmentName>
            <SubBuildingName>string</SubBuildingName>
            <Street>string</Street>
            <PostTown>string</PostTown>
            <PostCode>string</PostCode>
            <Organisation>string</Organisation>
            <Number>string</Number>
            <County>string</County>
            <BuildingName>string</BuildingName>
            <AbsRecNum>string</AbsRecNum>
            <FullAddress>string</FullAddress>
            <ListAddress>string</ListAddress>
            <DependentStreet>string</DependentStreet>
            <DoubleDependentLocality>string</DoubleDependentLocality>
            <GridEasting>string</GridEasting>
            <GridNorthing>string</GridNorthing>
            <PostOfficeBox>string</PostOfficeBox>
            <UserCategory>string</UserCategory>
            <DeliveryPointSuffix>string</DeliveryPointSuffix>
            <DeliveryPointNumber>int</DeliveryPointNumber>
          </SummaryAddress>
          <SummaryAddress>
            <IsError>boolean</IsError>
            <ErrorMessage>string</ErrorMessage>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <Locality>string</Locality>
            <DepartmentName>string</DepartmentName>
            <SubBuildingName>string</SubBuildingName>
            <Street>string</Street>
            <PostTown>string</PostTown>
            <PostCode>string</PostCode>
            <Organisation>string</Organisation>
            <Number>string</Number>
            <County>string</County>
            <BuildingName>string</BuildingName>
            <AbsRecNum>string</AbsRecNum>
            <FullAddress>string</FullAddress>
            <ListAddress>string</ListAddress>
            <DependentStreet>string</DependentStreet>
            <DoubleDependentLocality>string</DoubleDependentLocality>
            <GridEasting>string</GridEasting>
            <GridNorthing>string</GridNorthing>
            <PostOfficeBox>string</PostOfficeBox>
            <UserCategory>string</UserCategory>
            <DeliveryPointSuffix>string</DeliveryPointSuffix>
            <DeliveryPointNumber>int</DeliveryPointNumber>
          </SummaryAddress>
        </List>
      </SearchPostcodeResult>
    </SearchPostcodeResponse>
  </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 /uk/addressfinder.asmx/SearchPostcode?sPostcode=string&sAccountName=string&sGUID=string&sIPAddress=string HTTP/1.1
Host: ws2.epostcode.com

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

<?xml version="1.0" encoding="utf-8"?>
<SummaryAddresses xmlns="http://ws.epostcode.com/uk/">
  <IsError>boolean</IsError>
  <ErrorMessage>string</ErrorMessage>
  <List>
    <SummaryAddress>
      <IsError>boolean</IsError>
      <ErrorMessage>string</ErrorMessage>
      <AddressLine1>string</AddressLine1>
      <AddressLine2>string</AddressLine2>
      <AddressLine3>string</AddressLine3>
      <AddressLine4>string</AddressLine4>
      <AddressLine5>string</AddressLine5>
      <Locality>string</Locality>
      <DepartmentName>string</DepartmentName>
      <SubBuildingName>string</SubBuildingName>
      <Street>string</Street>
      <PostTown>string</PostTown>
      <PostCode>string</PostCode>
      <Organisation>string</Organisation>
      <Number>string</Number>
      <County>string</County>
      <BuildingName>string</BuildingName>
      <AbsRecNum>string</AbsRecNum>
      <FullAddress>string</FullAddress>
      <ListAddress>string</ListAddress>
      <DependentStreet>string</DependentStreet>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <GridEasting>string</GridEasting>
      <GridNorthing>string</GridNorthing>
      <PostOfficeBox>string</PostOfficeBox>
      <UserCategory>string</UserCategory>
      <DeliveryPointSuffix>string</DeliveryPointSuffix>
      <DeliveryPointNumber>int</DeliveryPointNumber>
    </SummaryAddress>
    <SummaryAddress>
      <IsError>boolean</IsError>
      <ErrorMessage>string</ErrorMessage>
      <AddressLine1>string</AddressLine1>
      <AddressLine2>string</AddressLine2>
      <AddressLine3>string</AddressLine3>
      <AddressLine4>string</AddressLine4>
      <AddressLine5>string</AddressLine5>
      <Locality>string</Locality>
      <DepartmentName>string</DepartmentName>
      <SubBuildingName>string</SubBuildingName>
      <Street>string</Street>
      <PostTown>string</PostTown>
      <PostCode>string</PostCode>
      <Organisation>string</Organisation>
      <Number>string</Number>
      <County>string</County>
      <BuildingName>string</BuildingName>
      <AbsRecNum>string</AbsRecNum>
      <FullAddress>string</FullAddress>
      <ListAddress>string</ListAddress>
      <DependentStreet>string</DependentStreet>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <GridEasting>string</GridEasting>
      <GridNorthing>string</GridNorthing>
      <PostOfficeBox>string</PostOfficeBox>
      <UserCategory>string</UserCategory>
      <DeliveryPointSuffix>string</DeliveryPointSuffix>
      <DeliveryPointNumber>int</DeliveryPointNumber>
    </SummaryAddress>
  </List>
</SummaryAddresses>

HTTP POST

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

POST /uk/addressfinder.asmx/SearchPostcode HTTP/1.1
Host: ws2.epostcode.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sPostcode=string&sAccountName=string&sGUID=string&sIPAddress=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SummaryAddresses xmlns="http://ws.epostcode.com/uk/">
  <IsError>boolean</IsError>
  <ErrorMessage>string</ErrorMessage>
  <List>
    <SummaryAddress>
      <IsError>boolean</IsError>
      <ErrorMessage>string</ErrorMessage>
      <AddressLine1>string</AddressLine1>
      <AddressLine2>string</AddressLine2>
      <AddressLine3>string</AddressLine3>
      <AddressLine4>string</AddressLine4>
      <AddressLine5>string</AddressLine5>
      <Locality>string</Locality>
      <DepartmentName>string</DepartmentName>
      <SubBuildingName>string</SubBuildingName>
      <Street>string</Street>
      <PostTown>string</PostTown>
      <PostCode>string</PostCode>
      <Organisation>string</Organisation>
      <Number>string</Number>
      <County>string</County>
      <BuildingName>string</BuildingName>
      <AbsRecNum>string</AbsRecNum>
      <FullAddress>string</FullAddress>
      <ListAddress>string</ListAddress>
      <DependentStreet>string</DependentStreet>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <GridEasting>string</GridEasting>
      <GridNorthing>string</GridNorthing>
      <PostOfficeBox>string</PostOfficeBox>
      <UserCategory>string</UserCategory>
      <DeliveryPointSuffix>string</DeliveryPointSuffix>
      <DeliveryPointNumber>int</DeliveryPointNumber>
    </SummaryAddress>
    <SummaryAddress>
      <IsError>boolean</IsError>
      <ErrorMessage>string</ErrorMessage>
      <AddressLine1>string</AddressLine1>
      <AddressLine2>string</AddressLine2>
      <AddressLine3>string</AddressLine3>
      <AddressLine4>string</AddressLine4>
      <AddressLine5>string</AddressLine5>
      <Locality>string</Locality>
      <DepartmentName>string</DepartmentName>
      <SubBuildingName>string</SubBuildingName>
      <Street>string</Street>
      <PostTown>string</PostTown>
      <PostCode>string</PostCode>
      <Organisation>string</Organisation>
      <Number>string</Number>
      <County>string</County>
      <BuildingName>string</BuildingName>
      <AbsRecNum>string</AbsRecNum>
      <FullAddress>string</FullAddress>
      <ListAddress>string</ListAddress>
      <DependentStreet>string</DependentStreet>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <GridEasting>string</GridEasting>
      <GridNorthing>string</GridNorthing>
      <PostOfficeBox>string</PostOfficeBox>
      <UserCategory>string</UserCategory>
      <DeliveryPointSuffix>string</DeliveryPointSuffix>
      <DeliveryPointNumber>int</DeliveryPointNumber>
    </SummaryAddress>
  </List>
</SummaryAddresses>