service


Click here for a complete list of operations.

SearchByPostcode

Search postcode data by a given postcode. Please note the system will return the results only if an exact result is found.

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 /api/service.asmx HTTP/1.1
Host: www.sglocate.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://sglocate.com/SearchByPostcode"

<?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>
    <SearchByPostcode xmlns="http://sglocate.com/">
      <APIKey>string</APIKey>
      <APISecret>string</APISecret>
      <Postcode>string</Postcode>
    </SearchByPostcode>
  </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>
    <SearchByPostcodeResponse xmlns="http://sglocate.com/">
      <SearchByPostcodeResult>
        <IsSuccess>boolean</IsSuccess>
        <ErrorCode>string</ErrorCode>
        <ErrorDetails>string</ErrorDetails>
        <Postcodes>
          <Postcode6D>
            <Postcode>string</Postcode>
            <BuildingNumber>string</BuildingNumber>
            <StreetName>string</StreetName>
            <BuildingName>string</BuildingName>
            <BuildingCode>string</BuildingCode>
            <BuildingDescription>string</BuildingDescription>
            <Longitude>string</Longitude>
            <Latitude>string</Latitude>
            <Floors xsi:nil="true" />
          </Postcode6D>
          <Postcode6D>
            <Postcode>string</Postcode>
            <BuildingNumber>string</BuildingNumber>
            <StreetName>string</StreetName>
            <BuildingName>string</BuildingName>
            <BuildingCode>string</BuildingCode>
            <BuildingDescription>string</BuildingDescription>
            <Longitude>string</Longitude>
            <Latitude>string</Latitude>
            <Floors xsi:nil="true" />
          </Postcode6D>
        </Postcodes>
      </SearchByPostcodeResult>
    </SearchByPostcodeResponse>
  </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 /api/service.asmx HTTP/1.1
Host: www.sglocate.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>
    <SearchByPostcode xmlns="http://sglocate.com/">
      <APIKey>string</APIKey>
      <APISecret>string</APISecret>
      <Postcode>string</Postcode>
    </SearchByPostcode>
  </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>
    <SearchByPostcodeResponse xmlns="http://sglocate.com/">
      <SearchByPostcodeResult>
        <IsSuccess>boolean</IsSuccess>
        <ErrorCode>string</ErrorCode>
        <ErrorDetails>string</ErrorDetails>
        <Postcodes>
          <Postcode6D>
            <Postcode>string</Postcode>
            <BuildingNumber>string</BuildingNumber>
            <StreetName>string</StreetName>
            <BuildingName>string</BuildingName>
            <BuildingCode>string</BuildingCode>
            <BuildingDescription>string</BuildingDescription>
            <Longitude>string</Longitude>
            <Latitude>string</Latitude>
            <Floors xsi:nil="true" />
          </Postcode6D>
          <Postcode6D>
            <Postcode>string</Postcode>
            <BuildingNumber>string</BuildingNumber>
            <StreetName>string</StreetName>
            <BuildingName>string</BuildingName>
            <BuildingCode>string</BuildingCode>
            <BuildingDescription>string</BuildingDescription>
            <Longitude>string</Longitude>
            <Latitude>string</Latitude>
            <Floors xsi:nil="true" />
          </Postcode6D>
        </Postcodes>
      </SearchByPostcodeResult>
    </SearchByPostcodeResponse>
  </soap12:Body>
</soap12:Envelope>