PostcodeServices13


Click here for a complete list of operations.

NearestData_ForPostcode

This function is used to return 'Nearest To' Data 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:
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/postcodeservices13.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_ForPostcode"

<?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_ForPostcode xmlns="http://ws.epostcode.com/uk/">
      <sPostcodeDatum>string</sPostcodeDatum>
      <sPostcodeList>string</sPostcodeList>
      <sPostcodeDescriptions>string</sPostcodeDescriptions>
      <sNumberToReturn>string</sNumberToReturn>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
    </NearestData_ForPostcode>
  </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_ForPostcodeResponse xmlns="http://ws.epostcode.com/uk/">
      <NearestData_ForPostcodeResult>
        <List>
          <Nearest>
            <Postcode_Datum>string</Postcode_Datum>
            <Postcode_Return>string</Postcode_Return>
            <Postcode_Description>string</Postcode_Description>
            <Ordinal_Position>string</Ordinal_Position>
            <Distance_Metres>string</Distance_Metres>
            <Distance_Kilometres>string</Distance_Kilometres>
            <Distance_Miles>string</Distance_Miles>
            <Distance_NauticalMiles>string</Distance_NauticalMiles>
            <Return_Code>string</Return_Code>
          </Nearest>
          <Nearest>
            <Postcode_Datum>string</Postcode_Datum>
            <Postcode_Return>string</Postcode_Return>
            <Postcode_Description>string</Postcode_Description>
            <Ordinal_Position>string</Ordinal_Position>
            <Distance_Metres>string</Distance_Metres>
            <Distance_Kilometres>string</Distance_Kilometres>
            <Distance_Miles>string</Distance_Miles>
            <Distance_NauticalMiles>string</Distance_NauticalMiles>
            <Return_Code>string</Return_Code>
          </Nearest>
        </List>
      </NearestData_ForPostcodeResult>
    </NearestData_ForPostcodeResponse>
  </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/postcodeservices13.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_ForPostcode xmlns="http://ws.epostcode.com/uk/">
      <sPostcodeDatum>string</sPostcodeDatum>
      <sPostcodeList>string</sPostcodeList>
      <sPostcodeDescriptions>string</sPostcodeDescriptions>
      <sNumberToReturn>string</sNumberToReturn>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
    </NearestData_ForPostcode>
  </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_ForPostcodeResponse xmlns="http://ws.epostcode.com/uk/">
      <NearestData_ForPostcodeResult>
        <List>
          <Nearest>
            <Postcode_Datum>string</Postcode_Datum>
            <Postcode_Return>string</Postcode_Return>
            <Postcode_Description>string</Postcode_Description>
            <Ordinal_Position>string</Ordinal_Position>
            <Distance_Metres>string</Distance_Metres>
            <Distance_Kilometres>string</Distance_Kilometres>
            <Distance_Miles>string</Distance_Miles>
            <Distance_NauticalMiles>string</Distance_NauticalMiles>
            <Return_Code>string</Return_Code>
          </Nearest>
          <Nearest>
            <Postcode_Datum>string</Postcode_Datum>
            <Postcode_Return>string</Postcode_Return>
            <Postcode_Description>string</Postcode_Description>
            <Ordinal_Position>string</Ordinal_Position>
            <Distance_Metres>string</Distance_Metres>
            <Distance_Kilometres>string</Distance_Kilometres>
            <Distance_Miles>string</Distance_Miles>
            <Distance_NauticalMiles>string</Distance_NauticalMiles>
            <Return_Code>string</Return_Code>
          </Nearest>
        </List>
      </NearestData_ForPostcodeResult>
    </NearestData_ForPostcodeResponse>
  </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/postcodeservices13.asmx/NearestData_ForPostcode?sPostcodeDatum=string&sPostcodeList=string&sPostcodeDescriptions=string&sNumberToReturn=string&AccountName=string&LicenceID=string&MachineID=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"?>
<Nearests xmlns="http://ws.epostcode.com/uk/">
  <List>
    <Nearest>
      <Postcode_Datum>string</Postcode_Datum>
      <Postcode_Return>string</Postcode_Return>
      <Postcode_Description>string</Postcode_Description>
      <Ordinal_Position>string</Ordinal_Position>
      <Distance_Metres>string</Distance_Metres>
      <Distance_Kilometres>string</Distance_Kilometres>
      <Distance_Miles>string</Distance_Miles>
      <Distance_NauticalMiles>string</Distance_NauticalMiles>
      <Return_Code>string</Return_Code>
    </Nearest>
    <Nearest>
      <Postcode_Datum>string</Postcode_Datum>
      <Postcode_Return>string</Postcode_Return>
      <Postcode_Description>string</Postcode_Description>
      <Ordinal_Position>string</Ordinal_Position>
      <Distance_Metres>string</Distance_Metres>
      <Distance_Kilometres>string</Distance_Kilometres>
      <Distance_Miles>string</Distance_Miles>
      <Distance_NauticalMiles>string</Distance_NauticalMiles>
      <Return_Code>string</Return_Code>
    </Nearest>
  </List>
</Nearests>

HTTP POST

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

POST /uk/postcodeservices13.asmx/NearestData_ForPostcode 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&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"?>
<Nearests xmlns="http://ws.epostcode.com/uk/">
  <List>
    <Nearest>
      <Postcode_Datum>string</Postcode_Datum>
      <Postcode_Return>string</Postcode_Return>
      <Postcode_Description>string</Postcode_Description>
      <Ordinal_Position>string</Ordinal_Position>
      <Distance_Metres>string</Distance_Metres>
      <Distance_Kilometres>string</Distance_Kilometres>
      <Distance_Miles>string</Distance_Miles>
      <Distance_NauticalMiles>string</Distance_NauticalMiles>
      <Return_Code>string</Return_Code>
    </Nearest>
    <Nearest>
      <Postcode_Datum>string</Postcode_Datum>
      <Postcode_Return>string</Postcode_Return>
      <Postcode_Description>string</Postcode_Description>
      <Ordinal_Position>string</Ordinal_Position>
      <Distance_Metres>string</Distance_Metres>
      <Distance_Kilometres>string</Distance_Kilometres>
      <Distance_Miles>string</Distance_Miles>
      <Distance_NauticalMiles>string</Distance_NauticalMiles>
      <Return_Code>string</Return_Code>
    </Nearest>
  </List>
</Nearests>