PostcodeServices


Click here for a complete list of operations.

GeoData_ForPostcode

This function is used to return Geographical Data for a Postcode or Postcodes. More Info at http://www.epostcode.com/what-is-epostcode/web-service-described/geographics

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sPostcodes:
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/GeoData_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>
    <GeoData_ForPostcode xmlns="http://ws.epostcode.com/uk/">
      <sPostcodes>string</sPostcodes>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
    </GeoData_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>
    <GeoData_ForPostcodeResponse xmlns="http://ws.epostcode.com/uk/">
      <GeoData_ForPostcodeResult>
        <List>
          <Geographic>
            <Postcode>string</Postcode>
            <Grid_Reference>string</Grid_Reference>
            <x_Coord>string</x_Coord>
            <y_Coord>string</y_Coord>
            <Latitude_Deg_Min_Sec>string</Latitude_Deg_Min_Sec>
            <Longitude_Deg_Min_Sec>string</Longitude_Deg_Min_Sec>
            <Latitude_Degrees>string</Latitude_Degrees>
            <Longitude_Degrees>string</Longitude_Degrees>
            <Country_Code>string</Country_Code>
            <Country_Name>string</Country_Name>
            <Administrative_County>string</Administrative_County>
            <Local_Auth_Name>string</Local_Auth_Name>
            <Local_Auth_Ward_Code>string</Local_Auth_Ward_Code>
            <Local_Auth_Ward_Name>string</Local_Auth_Ward_Name>
            <NHS_Regional_Office>string</NHS_Regional_Office>
            <NHS_Strat_Health_Board_Code>string</NHS_Strat_Health_Board_Code>
            <NHS_Strat_Health_Board_Name>string</NHS_Strat_Health_Board_Name>
            <NHS_Primary_Health_Auth_Code>string</NHS_Primary_Health_Auth_Code>
            <NHS_Primary_Health_Board_Code>string</NHS_Primary_Health_Board_Code>
            <NHS_Primary_Health_Board_Name>string</NHS_Primary_Health_Board_Name>
            <M_Details>string</M_Details>
            <G_Details>string</G_Details>
            <Return_Code>string</Return_Code>
          </Geographic>
          <Geographic>
            <Postcode>string</Postcode>
            <Grid_Reference>string</Grid_Reference>
            <x_Coord>string</x_Coord>
            <y_Coord>string</y_Coord>
            <Latitude_Deg_Min_Sec>string</Latitude_Deg_Min_Sec>
            <Longitude_Deg_Min_Sec>string</Longitude_Deg_Min_Sec>
            <Latitude_Degrees>string</Latitude_Degrees>
            <Longitude_Degrees>string</Longitude_Degrees>
            <Country_Code>string</Country_Code>
            <Country_Name>string</Country_Name>
            <Administrative_County>string</Administrative_County>
            <Local_Auth_Name>string</Local_Auth_Name>
            <Local_Auth_Ward_Code>string</Local_Auth_Ward_Code>
            <Local_Auth_Ward_Name>string</Local_Auth_Ward_Name>
            <NHS_Regional_Office>string</NHS_Regional_Office>
            <NHS_Strat_Health_Board_Code>string</NHS_Strat_Health_Board_Code>
            <NHS_Strat_Health_Board_Name>string</NHS_Strat_Health_Board_Name>
            <NHS_Primary_Health_Auth_Code>string</NHS_Primary_Health_Auth_Code>
            <NHS_Primary_Health_Board_Code>string</NHS_Primary_Health_Board_Code>
            <NHS_Primary_Health_Board_Name>string</NHS_Primary_Health_Board_Name>
            <M_Details>string</M_Details>
            <G_Details>string</G_Details>
            <Return_Code>string</Return_Code>
          </Geographic>
        </List>
      </GeoData_ForPostcodeResult>
    </GeoData_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/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>
    <GeoData_ForPostcode xmlns="http://ws.epostcode.com/uk/">
      <sPostcodes>string</sPostcodes>
      <AccountName>string</AccountName>
      <LicenceID>string</LicenceID>
      <MachineID>string</MachineID>
    </GeoData_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>
    <GeoData_ForPostcodeResponse xmlns="http://ws.epostcode.com/uk/">
      <GeoData_ForPostcodeResult>
        <List>
          <Geographic>
            <Postcode>string</Postcode>
            <Grid_Reference>string</Grid_Reference>
            <x_Coord>string</x_Coord>
            <y_Coord>string</y_Coord>
            <Latitude_Deg_Min_Sec>string</Latitude_Deg_Min_Sec>
            <Longitude_Deg_Min_Sec>string</Longitude_Deg_Min_Sec>
            <Latitude_Degrees>string</Latitude_Degrees>
            <Longitude_Degrees>string</Longitude_Degrees>
            <Country_Code>string</Country_Code>
            <Country_Name>string</Country_Name>
            <Administrative_County>string</Administrative_County>
            <Local_Auth_Name>string</Local_Auth_Name>
            <Local_Auth_Ward_Code>string</Local_Auth_Ward_Code>
            <Local_Auth_Ward_Name>string</Local_Auth_Ward_Name>
            <NHS_Regional_Office>string</NHS_Regional_Office>
            <NHS_Strat_Health_Board_Code>string</NHS_Strat_Health_Board_Code>
            <NHS_Strat_Health_Board_Name>string</NHS_Strat_Health_Board_Name>
            <NHS_Primary_Health_Auth_Code>string</NHS_Primary_Health_Auth_Code>
            <NHS_Primary_Health_Board_Code>string</NHS_Primary_Health_Board_Code>
            <NHS_Primary_Health_Board_Name>string</NHS_Primary_Health_Board_Name>
            <M_Details>string</M_Details>
            <G_Details>string</G_Details>
            <Return_Code>string</Return_Code>
          </Geographic>
          <Geographic>
            <Postcode>string</Postcode>
            <Grid_Reference>string</Grid_Reference>
            <x_Coord>string</x_Coord>
            <y_Coord>string</y_Coord>
            <Latitude_Deg_Min_Sec>string</Latitude_Deg_Min_Sec>
            <Longitude_Deg_Min_Sec>string</Longitude_Deg_Min_Sec>
            <Latitude_Degrees>string</Latitude_Degrees>
            <Longitude_Degrees>string</Longitude_Degrees>
            <Country_Code>string</Country_Code>
            <Country_Name>string</Country_Name>
            <Administrative_County>string</Administrative_County>
            <Local_Auth_Name>string</Local_Auth_Name>
            <Local_Auth_Ward_Code>string</Local_Auth_Ward_Code>
            <Local_Auth_Ward_Name>string</Local_Auth_Ward_Name>
            <NHS_Regional_Office>string</NHS_Regional_Office>
            <NHS_Strat_Health_Board_Code>string</NHS_Strat_Health_Board_Code>
            <NHS_Strat_Health_Board_Name>string</NHS_Strat_Health_Board_Name>
            <NHS_Primary_Health_Auth_Code>string</NHS_Primary_Health_Auth_Code>
            <NHS_Primary_Health_Board_Code>string</NHS_Primary_Health_Board_Code>
            <NHS_Primary_Health_Board_Name>string</NHS_Primary_Health_Board_Name>
            <M_Details>string</M_Details>
            <G_Details>string</G_Details>
            <Return_Code>string</Return_Code>
          </Geographic>
        </List>
      </GeoData_ForPostcodeResult>
    </GeoData_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/postcodeservices.asmx/GeoData_ForPostcode?sPostcodes=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"?>
<Geographics xmlns="http://ws.epostcode.com/uk/">
  <List>
    <Geographic>
      <Postcode>string</Postcode>
      <Grid_Reference>string</Grid_Reference>
      <x_Coord>string</x_Coord>
      <y_Coord>string</y_Coord>
      <Latitude_Deg_Min_Sec>string</Latitude_Deg_Min_Sec>
      <Longitude_Deg_Min_Sec>string</Longitude_Deg_Min_Sec>
      <Latitude_Degrees>string</Latitude_Degrees>
      <Longitude_Degrees>string</Longitude_Degrees>
      <Country_Code>string</Country_Code>
      <Country_Name>string</Country_Name>
      <Administrative_County>string</Administrative_County>
      <Local_Auth_Name>string</Local_Auth_Name>
      <Local_Auth_Ward_Code>string</Local_Auth_Ward_Code>
      <Local_Auth_Ward_Name>string</Local_Auth_Ward_Name>
      <NHS_Regional_Office>string</NHS_Regional_Office>
      <NHS_Strat_Health_Board_Code>string</NHS_Strat_Health_Board_Code>
      <NHS_Strat_Health_Board_Name>string</NHS_Strat_Health_Board_Name>
      <NHS_Primary_Health_Auth_Code>string</NHS_Primary_Health_Auth_Code>
      <NHS_Primary_Health_Board_Code>string</NHS_Primary_Health_Board_Code>
      <NHS_Primary_Health_Board_Name>string</NHS_Primary_Health_Board_Name>
      <M_Details>string</M_Details>
      <G_Details>string</G_Details>
      <Return_Code>string</Return_Code>
    </Geographic>
    <Geographic>
      <Postcode>string</Postcode>
      <Grid_Reference>string</Grid_Reference>
      <x_Coord>string</x_Coord>
      <y_Coord>string</y_Coord>
      <Latitude_Deg_Min_Sec>string</Latitude_Deg_Min_Sec>
      <Longitude_Deg_Min_Sec>string</Longitude_Deg_Min_Sec>
      <Latitude_Degrees>string</Latitude_Degrees>
      <Longitude_Degrees>string</Longitude_Degrees>
      <Country_Code>string</Country_Code>
      <Country_Name>string</Country_Name>
      <Administrative_County>string</Administrative_County>
      <Local_Auth_Name>string</Local_Auth_Name>
      <Local_Auth_Ward_Code>string</Local_Auth_Ward_Code>
      <Local_Auth_Ward_Name>string</Local_Auth_Ward_Name>
      <NHS_Regional_Office>string</NHS_Regional_Office>
      <NHS_Strat_Health_Board_Code>string</NHS_Strat_Health_Board_Code>
      <NHS_Strat_Health_Board_Name>string</NHS_Strat_Health_Board_Name>
      <NHS_Primary_Health_Auth_Code>string</NHS_Primary_Health_Auth_Code>
      <NHS_Primary_Health_Board_Code>string</NHS_Primary_Health_Board_Code>
      <NHS_Primary_Health_Board_Name>string</NHS_Primary_Health_Board_Name>
      <M_Details>string</M_Details>
      <G_Details>string</G_Details>
      <Return_Code>string</Return_Code>
    </Geographic>
  </List>
</Geographics>

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

sPostcodes=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"?>
<Geographics xmlns="http://ws.epostcode.com/uk/">
  <List>
    <Geographic>
      <Postcode>string</Postcode>
      <Grid_Reference>string</Grid_Reference>
      <x_Coord>string</x_Coord>
      <y_Coord>string</y_Coord>
      <Latitude_Deg_Min_Sec>string</Latitude_Deg_Min_Sec>
      <Longitude_Deg_Min_Sec>string</Longitude_Deg_Min_Sec>
      <Latitude_Degrees>string</Latitude_Degrees>
      <Longitude_Degrees>string</Longitude_Degrees>
      <Country_Code>string</Country_Code>
      <Country_Name>string</Country_Name>
      <Administrative_County>string</Administrative_County>
      <Local_Auth_Name>string</Local_Auth_Name>
      <Local_Auth_Ward_Code>string</Local_Auth_Ward_Code>
      <Local_Auth_Ward_Name>string</Local_Auth_Ward_Name>
      <NHS_Regional_Office>string</NHS_Regional_Office>
      <NHS_Strat_Health_Board_Code>string</NHS_Strat_Health_Board_Code>
      <NHS_Strat_Health_Board_Name>string</NHS_Strat_Health_Board_Name>
      <NHS_Primary_Health_Auth_Code>string</NHS_Primary_Health_Auth_Code>
      <NHS_Primary_Health_Board_Code>string</NHS_Primary_Health_Board_Code>
      <NHS_Primary_Health_Board_Name>string</NHS_Primary_Health_Board_Name>
      <M_Details>string</M_Details>
      <G_Details>string</G_Details>
      <Return_Code>string</Return_Code>
    </Geographic>
    <Geographic>
      <Postcode>string</Postcode>
      <Grid_Reference>string</Grid_Reference>
      <x_Coord>string</x_Coord>
      <y_Coord>string</y_Coord>
      <Latitude_Deg_Min_Sec>string</Latitude_Deg_Min_Sec>
      <Longitude_Deg_Min_Sec>string</Longitude_Deg_Min_Sec>
      <Latitude_Degrees>string</Latitude_Degrees>
      <Longitude_Degrees>string</Longitude_Degrees>
      <Country_Code>string</Country_Code>
      <Country_Name>string</Country_Name>
      <Administrative_County>string</Administrative_County>
      <Local_Auth_Name>string</Local_Auth_Name>
      <Local_Auth_Ward_Code>string</Local_Auth_Ward_Code>
      <Local_Auth_Ward_Name>string</Local_Auth_Ward_Name>
      <NHS_Regional_Office>string</NHS_Regional_Office>
      <NHS_Strat_Health_Board_Code>string</NHS_Strat_Health_Board_Code>
      <NHS_Strat_Health_Board_Name>string</NHS_Strat_Health_Board_Name>
      <NHS_Primary_Health_Auth_Code>string</NHS_Primary_Health_Auth_Code>
      <NHS_Primary_Health_Board_Code>string</NHS_Primary_Health_Board_Code>
      <NHS_Primary_Health_Board_Name>string</NHS_Primary_Health_Board_Name>
      <M_Details>string</M_Details>
      <G_Details>string</G_Details>
      <Return_Code>string</Return_Code>
    </Geographic>
  </List>
</Geographics>