PostcodeServices


Click here for a complete list of operations.

SearchThoroughfare_ByPostcodeDistrict

This function is used to return a List of Thoroughfares for a Search on a Postcode District.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sPostcode:
AccountName:
LicenceID:
MachineID:

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

<?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>
    <SearchThoroughfare_ByPostcodeDistrict xmlns="http://ws.epostcode.com/uk/">
      <sPostcode>string</sPostcode>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
    </SearchThoroughfare_ByPostcodeDistrict>
  </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>
    <SearchThoroughfare_ByPostcodeDistrictResponse xmlns="http://ws.epostcode.com/uk/">
      <SearchThoroughfare_ByPostcodeDistrictResult>
        <List>
          <ListAddressThoroughfare>
            <List_Address>string</List_Address>
            <Identifier>string</Identifier>
            <Return_Code>string</Return_Code>
          </ListAddressThoroughfare>
          <ListAddressThoroughfare>
            <List_Address>string</List_Address>
            <Identifier>string</Identifier>
            <Return_Code>string</Return_Code>
          </ListAddressThoroughfare>
        </List>
      </SearchThoroughfare_ByPostcodeDistrictResult>
    </SearchThoroughfare_ByPostcodeDistrictResponse>
  </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/postcodeservices.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>
    <SearchThoroughfare_ByPostcodeDistrict xmlns="http://ws.epostcode.com/uk/">
      <sPostcode>string</sPostcode>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
    </SearchThoroughfare_ByPostcodeDistrict>
  </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>
    <SearchThoroughfare_ByPostcodeDistrictResponse xmlns="http://ws.epostcode.com/uk/">
      <SearchThoroughfare_ByPostcodeDistrictResult>
        <List>
          <ListAddressThoroughfare>
            <List_Address>string</List_Address>
            <Identifier>string</Identifier>
            <Return_Code>string</Return_Code>
          </ListAddressThoroughfare>
          <ListAddressThoroughfare>
            <List_Address>string</List_Address>
            <Identifier>string</Identifier>
            <Return_Code>string</Return_Code>
          </ListAddressThoroughfare>
        </List>
      </SearchThoroughfare_ByPostcodeDistrictResult>
    </SearchThoroughfare_ByPostcodeDistrictResponse>
  </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/postcodeservices.asmx/SearchThoroughfare_ByPostcodeDistrict?sPostcode=string&AccountName=string&LicenceID=string&MachineID=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"?>
<ListAddressThoroughfares xmlns="http://ws.epostcode.com/uk/">
  <List>
    <ListAddressThoroughfare>
      <List_Address>string</List_Address>
      <Identifier>string</Identifier>
      <Return_Code>string</Return_Code>
    </ListAddressThoroughfare>
    <ListAddressThoroughfare>
      <List_Address>string</List_Address>
      <Identifier>string</Identifier>
      <Return_Code>string</Return_Code>
    </ListAddressThoroughfare>
  </List>
</ListAddressThoroughfares>

HTTP POST

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

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

sPostcode=string&AccountName=string&LicenceID=string&MachineID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ListAddressThoroughfares xmlns="http://ws.epostcode.com/uk/">
  <List>
    <ListAddressThoroughfare>
      <List_Address>string</List_Address>
      <Identifier>string</Identifier>
      <Return_Code>string</Return_Code>
    </ListAddressThoroughfare>
    <ListAddressThoroughfare>
      <List_Address>string</List_Address>
      <Identifier>string</Identifier>
      <Return_Code>string</Return_Code>
    </ListAddressThoroughfare>
  </List>
</ListAddressThoroughfares>