PostcodeServices09


Click here for a complete list of operations.

NearestData_ForPostcodeWithinAMaximumRadius

This function is used to return 'Nearest To' Data and a Google maps string for a Postcode based on a List of Postcodes. More Info at http://www.epostcode.com/what-is-epostcode/web-service-described/nearest-data

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sPostcodeDatum:
sPostcodeList:
sPostcodeDescriptions:
sNumberToReturn:
sGoogleKey:
AccountName:
LicenceID:
MachineID:
sRadius:
sType:

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

<?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>
    <NearestData_ForPostcodeWithinAMaximumRadius xmlns="http://ws.epostcode.com/uk/">
      <sPostcodeDatum>string</sPostcodeDatum>
      <sPostcodeList>string</sPostcodeList>
      <sPostcodeDescriptions>string</sPostcodeDescriptions>
      <sNumberToReturn>string</sNumberToReturn>
      <sGoogleKey>string</sGoogleKey>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
      <sRadius>string</sRadius>
      <sType>string</sType>
    </NearestData_ForPostcodeWithinAMaximumRadius>
  </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>
    <NearestData_ForPostcodeWithinAMaximumRadiusResponse xmlns="http://ws.epostcode.com/uk/">
      <NearestData_ForPostcodeWithinAMaximumRadiusResult>string</NearestData_ForPostcodeWithinAMaximumRadiusResult>
    </NearestData_ForPostcodeWithinAMaximumRadiusResponse>
  </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/postcodeservices09.asmx HTTP/1.1
Host: ws.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>
    <NearestData_ForPostcodeWithinAMaximumRadius xmlns="http://ws.epostcode.com/uk/">
      <sPostcodeDatum>string</sPostcodeDatum>
      <sPostcodeList>string</sPostcodeList>
      <sPostcodeDescriptions>string</sPostcodeDescriptions>
      <sNumberToReturn>string</sNumberToReturn>
      <sGoogleKey>string</sGoogleKey>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
      <sRadius>string</sRadius>
      <sType>string</sType>
    </NearestData_ForPostcodeWithinAMaximumRadius>
  </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>
    <NearestData_ForPostcodeWithinAMaximumRadiusResponse xmlns="http://ws.epostcode.com/uk/">
      <NearestData_ForPostcodeWithinAMaximumRadiusResult>string</NearestData_ForPostcodeWithinAMaximumRadiusResult>
    </NearestData_ForPostcodeWithinAMaximumRadiusResponse>
  </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/postcodeservices09.asmx/NearestData_ForPostcodeWithinAMaximumRadius?sPostcodeDatum=string&sPostcodeList=string&sPostcodeDescriptions=string&sNumberToReturn=string&sGoogleKey=string&AccountName=string&LicenceID=string&MachineID=string&sRadius=string&sType=string HTTP/1.1
Host: ws.epostcode.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://ws.epostcode.com/uk/">string</string>

HTTP POST

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

POST /uk/postcodeservices09.asmx/NearestData_ForPostcodeWithinAMaximumRadius HTTP/1.1
Host: ws.epostcode.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sPostcodeDatum=string&sPostcodeList=string&sPostcodeDescriptions=string&sNumberToReturn=string&sGoogleKey=string&AccountName=string&LicenceID=string&MachineID=string&sRadius=string&sType=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://ws.epostcode.com/uk/">string</string>