WebService Web Service

WebService

Click here for a complete list of operations.

GetAddressRecord

Get Address record based on the Address ID, return AddressRecord

Test

The test form is only available for requests from the local machine.

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 /WebService.asmx HTTP/1.1
Host: www.simplylookupadmin.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.simply-postcode-lookup.com/GetAddressRecord"

<?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>
    <GetAddressRecord xmlns="http://www.simply-postcode-lookup.com/">
      <DataKey>string</DataKey>
      <Username>string</Username>
      <SearchType>string</SearchType>
      <AddressID>string</AddressID>
    </GetAddressRecord>
  </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>
    <GetAddressRecordResponse xmlns="http://www.simply-postcode-lookup.com/">
      <GetAddressRecordResult>
        <AddressRecordGotWithoutError>boolean</AddressRecordGotWithoutError>
        <ErrorMessage>string</ErrorMessage>
        <CreditsStatusText />
        <BuyMoreCreditsURL />
        <CompanyName>string</CompanyName>
        <Line1>string</Line1>
        <Line2>string</Line2>
        <Line3>string</Line3>
        <Town>string</Town>
        <CountyState>string</CountyState>
        <PostZipCode>string</PostZipCode>
        <Country>string</Country>
        <DeliveryPointSuffix>string</DeliveryPointSuffix>
        <NoHouseHolds>string</NoHouseHolds>
        <SmallOrg>string</SmallOrg>
        <MailSort>string</MailSort>
        <Spare>string</Spare>
        <UDPRN>string</UDPRN>
        <Unique>string</Unique>
        <longitude_WGS84>string</longitude_WGS84>
        <latitude_WGS84>string</latitude_WGS84>
        <UK_os_reference>string</UK_os_reference>
        <UK_OS_grid_east>string</UK_OS_grid_east>
        <UK_OS_grid_north>string</UK_OS_grid_north>
        <UK_NHS_code>string</UK_NHS_code>
        <UK_NHS_region>string</UK_NHS_region>
        <UK_country>string</UK_country>
        <UK_IntroductionDate>string</UK_IntroductionDate>
        <UK_county>string</UK_county>
        <UK_district>string</UK_district>
        <UK_ward>string</UK_ward>
        <UK_wardstatus>string</UK_wardstatus>
        <UK_gridstatus>string</UK_gridstatus>
        <GeoDistanceToHomePostcode>string</GeoDistanceToHomePostcode>
      </GetAddressRecordResult>
    </GetAddressRecordResponse>
  </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 /WebService.asmx HTTP/1.1
Host: www.simplylookupadmin.co.uk
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>
    <GetAddressRecord xmlns="http://www.simply-postcode-lookup.com/">
      <DataKey>string</DataKey>
      <Username>string</Username>
      <SearchType>string</SearchType>
      <AddressID>string</AddressID>
    </GetAddressRecord>
  </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>
    <GetAddressRecordResponse xmlns="http://www.simply-postcode-lookup.com/">
      <GetAddressRecordResult>
        <AddressRecordGotWithoutError>boolean</AddressRecordGotWithoutError>
        <ErrorMessage>string</ErrorMessage>
        <CreditsStatusText />
        <BuyMoreCreditsURL />
        <CompanyName>string</CompanyName>
        <Line1>string</Line1>
        <Line2>string</Line2>
        <Line3>string</Line3>
        <Town>string</Town>
        <CountyState>string</CountyState>
        <PostZipCode>string</PostZipCode>
        <Country>string</Country>
        <DeliveryPointSuffix>string</DeliveryPointSuffix>
        <NoHouseHolds>string</NoHouseHolds>
        <SmallOrg>string</SmallOrg>
        <MailSort>string</MailSort>
        <Spare>string</Spare>
        <UDPRN>string</UDPRN>
        <Unique>string</Unique>
        <longitude_WGS84>string</longitude_WGS84>
        <latitude_WGS84>string</latitude_WGS84>
        <UK_os_reference>string</UK_os_reference>
        <UK_OS_grid_east>string</UK_OS_grid_east>
        <UK_OS_grid_north>string</UK_OS_grid_north>
        <UK_NHS_code>string</UK_NHS_code>
        <UK_NHS_region>string</UK_NHS_region>
        <UK_country>string</UK_country>
        <UK_IntroductionDate>string</UK_IntroductionDate>
        <UK_county>string</UK_county>
        <UK_district>string</UK_district>
        <UK_ward>string</UK_ward>
        <UK_wardstatus>string</UK_wardstatus>
        <UK_gridstatus>string</UK_gridstatus>
        <GeoDistanceToHomePostcode>string</GeoDistanceToHomePostcode>
      </GetAddressRecordResult>
    </GetAddressRecordResponse>
  </soap12:Body>
</soap12:Envelope>