PostcodeServices


Click here for a complete list of operations.

SearchPremise_ByPOBox_Dataset

This function is used to return a List of Premises for a Search on Post Office Box. (Returns a Strongly Typed 'PostcodeUtilities' Dataset with populated 'ListAddressPremise' table). More Info at http://www.epostcode.com/what-is-epostcode/web-service-described/search-premise

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sPOBox:
sTown:
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/SearchPremise_ByPOBox_Dataset"

<?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>
    <SearchPremise_ByPOBox_Dataset xmlns="http://ws.epostcode.com/uk/">
      <sPOBox>string</sPOBox>
      <sTown>string</sTown>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
    </SearchPremise_ByPOBox_Dataset>
  </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>
    <SearchPremise_ByPOBox_DatasetResponse xmlns="http://ws.epostcode.com/uk/">
      <SearchPremise_ByPOBox_DatasetResult>dataset</SearchPremise_ByPOBox_DatasetResult>
    </SearchPremise_ByPOBox_DatasetResponse>
  </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>
    <SearchPremise_ByPOBox_Dataset xmlns="http://ws.epostcode.com/uk/">
      <sPOBox>string</sPOBox>
      <sTown>string</sTown>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
    </SearchPremise_ByPOBox_Dataset>
  </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>
    <SearchPremise_ByPOBox_DatasetResponse xmlns="http://ws.epostcode.com/uk/">
      <SearchPremise_ByPOBox_DatasetResult>dataset</SearchPremise_ByPOBox_DatasetResult>
    </SearchPremise_ByPOBox_DatasetResponse>
  </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/SearchPremise_ByPOBox_Dataset?sPOBox=string&sTown=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"?>
<PostcodeUtilities xmlns="http://ws.epostcode.com/uk/">dataset</PostcodeUtilities>

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/SearchPremise_ByPOBox_Dataset HTTP/1.1
Host: ws2.epostcode.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sPOBox=string&sTown=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"?>
<PostcodeUtilities xmlns="http://ws.epostcode.com/uk/">dataset</PostcodeUtilities>