PostcodeIT_UK


Click here for a complete list of operations.

GetByPostcodeFiltered

Retrieves a collection of addresses from the database by postcode and a house number/building name. Postcode is not case sensitive and so can be upper or lower case.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
postcode:
premises:

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 /postcodeit/postcodeit_uk.asmx HTTP/1.1
Host: services.mosaicsoftware.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.mosaicsoftware.co.uk/services/GetByPostcodeFiltered"

<?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:Header>
    <PostcodeITHeader xmlns="www.mosaicsoftware.co.uk/services/">
      <CustomerId>string</CustomerId>
      <LicenceKey>string</LicenceKey>
      <MachineId>string</MachineId>
    </PostcodeITHeader>
  </soap:Header>
  <soap:Body>
    <GetByPostcodeFiltered xmlns="www.mosaicsoftware.co.uk/services/">
      <postcode>string</postcode>
      <premises>string</premises>
    </GetByPostcodeFiltered>
  </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>
    <GetByPostcodeFilteredResponse xmlns="www.mosaicsoftware.co.uk/services/">
      <GetByPostcodeFilteredResult>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
        <Results>
          <PafAddress>
            <Postcode>string</Postcode>
            <DepartmentName>string</DepartmentName>
            <OrganisationName>string</OrganisationName>
            <BuildingNumber>int</BuildingNumber>
            <BuildingName>string</BuildingName>
            <SubBuildingName>string</SubBuildingName>
            <StreetName>string</StreetName>
            <ThoroughfareName>string</ThoroughfareName>
            <ThoroughfareDescriptor>string</ThoroughfareDescriptor>
            <PostTown>string</PostTown>
            <DependentLocality>string</DependentLocality>
            <DoubleDependentLocality>string</DoubleDependentLocality>
            <AddressKey>int</AddressKey>
            <NumberOfHouseholds>int</NumberOfHouseholds>
            <CSV xsi:nil="true" />
            <Summary2 xsi:nil="true" />
          </PafAddress>
          <PafAddress>
            <Postcode>string</Postcode>
            <DepartmentName>string</DepartmentName>
            <OrganisationName>string</OrganisationName>
            <BuildingNumber>int</BuildingNumber>
            <BuildingName>string</BuildingName>
            <SubBuildingName>string</SubBuildingName>
            <StreetName>string</StreetName>
            <ThoroughfareName>string</ThoroughfareName>
            <ThoroughfareDescriptor>string</ThoroughfareDescriptor>
            <PostTown>string</PostTown>
            <DependentLocality>string</DependentLocality>
            <DoubleDependentLocality>string</DoubleDependentLocality>
            <AddressKey>int</AddressKey>
            <NumberOfHouseholds>int</NumberOfHouseholds>
            <CSV xsi:nil="true" />
            <Summary2 xsi:nil="true" />
          </PafAddress>
        </Results>
      </GetByPostcodeFilteredResult>
    </GetByPostcodeFilteredResponse>
  </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 /postcodeit/postcodeit_uk.asmx HTTP/1.1
Host: services.mosaicsoftware.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:Header>
    <PostcodeITHeader xmlns="www.mosaicsoftware.co.uk/services/">
      <CustomerId>string</CustomerId>
      <LicenceKey>string</LicenceKey>
      <MachineId>string</MachineId>
    </PostcodeITHeader>
  </soap12:Header>
  <soap12:Body>
    <GetByPostcodeFiltered xmlns="www.mosaicsoftware.co.uk/services/">
      <postcode>string</postcode>
      <premises>string</premises>
    </GetByPostcodeFiltered>
  </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>
    <GetByPostcodeFilteredResponse xmlns="www.mosaicsoftware.co.uk/services/">
      <GetByPostcodeFilteredResult>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
        <Results>
          <PafAddress>
            <Postcode>string</Postcode>
            <DepartmentName>string</DepartmentName>
            <OrganisationName>string</OrganisationName>
            <BuildingNumber>int</BuildingNumber>
            <BuildingName>string</BuildingName>
            <SubBuildingName>string</SubBuildingName>
            <StreetName>string</StreetName>
            <ThoroughfareName>string</ThoroughfareName>
            <ThoroughfareDescriptor>string</ThoroughfareDescriptor>
            <PostTown>string</PostTown>
            <DependentLocality>string</DependentLocality>
            <DoubleDependentLocality>string</DoubleDependentLocality>
            <AddressKey>int</AddressKey>
            <NumberOfHouseholds>int</NumberOfHouseholds>
            <CSV xsi:nil="true" />
            <Summary2 xsi:nil="true" />
          </PafAddress>
          <PafAddress>
            <Postcode>string</Postcode>
            <DepartmentName>string</DepartmentName>
            <OrganisationName>string</OrganisationName>
            <BuildingNumber>int</BuildingNumber>
            <BuildingName>string</BuildingName>
            <SubBuildingName>string</SubBuildingName>
            <StreetName>string</StreetName>
            <ThoroughfareName>string</ThoroughfareName>
            <ThoroughfareDescriptor>string</ThoroughfareDescriptor>
            <PostTown>string</PostTown>
            <DependentLocality>string</DependentLocality>
            <DoubleDependentLocality>string</DoubleDependentLocality>
            <AddressKey>int</AddressKey>
            <NumberOfHouseholds>int</NumberOfHouseholds>
            <CSV xsi:nil="true" />
            <Summary2 xsi:nil="true" />
          </PafAddress>
        </Results>
      </GetByPostcodeFilteredResult>
    </GetByPostcodeFilteredResponse>
  </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 /postcodeit/postcodeit_uk.asmx/GetByPostcodeFiltered?postcode=string&premises=string HTTP/1.1
Host: services.mosaicsoftware.co.uk
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<PafAddressResponse xmlns="www.mosaicsoftware.co.uk/services/">
  <ResultCode>int</ResultCode>
  <ResultMessage>string</ResultMessage>
  <Results>
    <PafAddress>
      <Postcode>string</Postcode>
      <DepartmentName>string</DepartmentName>
      <OrganisationName>string</OrganisationName>
      <BuildingNumber>int</BuildingNumber>
      <BuildingName>string</BuildingName>
      <SubBuildingName>string</SubBuildingName>
      <StreetName>string</StreetName>
      <ThoroughfareName>string</ThoroughfareName>
      <ThoroughfareDescriptor>string</ThoroughfareDescriptor>
      <PostTown>string</PostTown>
      <DependentLocality>string</DependentLocality>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <AddressKey>int</AddressKey>
      <NumberOfHouseholds>int</NumberOfHouseholds>
      <CSV>
        <AddressKey>int</AddressKey>
        <SummaryAddress>string</SummaryAddress>
      </CSV>
      <Summary2>
        <string>string</string>
        <string>string</string>
      </Summary2>
    </PafAddress>
    <PafAddress>
      <Postcode>string</Postcode>
      <DepartmentName>string</DepartmentName>
      <OrganisationName>string</OrganisationName>
      <BuildingNumber>int</BuildingNumber>
      <BuildingName>string</BuildingName>
      <SubBuildingName>string</SubBuildingName>
      <StreetName>string</StreetName>
      <ThoroughfareName>string</ThoroughfareName>
      <ThoroughfareDescriptor>string</ThoroughfareDescriptor>
      <PostTown>string</PostTown>
      <DependentLocality>string</DependentLocality>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <AddressKey>int</AddressKey>
      <NumberOfHouseholds>int</NumberOfHouseholds>
      <CSV>
        <AddressKey>int</AddressKey>
        <SummaryAddress>string</SummaryAddress>
      </CSV>
      <Summary2>
        <string>string</string>
        <string>string</string>
      </Summary2>
    </PafAddress>
  </Results>
</PafAddressResponse>

HTTP POST

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

POST /postcodeit/postcodeit_uk.asmx/GetByPostcodeFiltered HTTP/1.1
Host: services.mosaicsoftware.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

postcode=string&premises=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<PafAddressResponse xmlns="www.mosaicsoftware.co.uk/services/">
  <ResultCode>int</ResultCode>
  <ResultMessage>string</ResultMessage>
  <Results>
    <PafAddress>
      <Postcode>string</Postcode>
      <DepartmentName>string</DepartmentName>
      <OrganisationName>string</OrganisationName>
      <BuildingNumber>int</BuildingNumber>
      <BuildingName>string</BuildingName>
      <SubBuildingName>string</SubBuildingName>
      <StreetName>string</StreetName>
      <ThoroughfareName>string</ThoroughfareName>
      <ThoroughfareDescriptor>string</ThoroughfareDescriptor>
      <PostTown>string</PostTown>
      <DependentLocality>string</DependentLocality>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <AddressKey>int</AddressKey>
      <NumberOfHouseholds>int</NumberOfHouseholds>
      <CSV>
        <AddressKey>int</AddressKey>
        <SummaryAddress>string</SummaryAddress>
      </CSV>
      <Summary2>
        <string>string</string>
        <string>string</string>
      </Summary2>
    </PafAddress>
    <PafAddress>
      <Postcode>string</Postcode>
      <DepartmentName>string</DepartmentName>
      <OrganisationName>string</OrganisationName>
      <BuildingNumber>int</BuildingNumber>
      <BuildingName>string</BuildingName>
      <SubBuildingName>string</SubBuildingName>
      <StreetName>string</StreetName>
      <ThoroughfareName>string</ThoroughfareName>
      <ThoroughfareDescriptor>string</ThoroughfareDescriptor>
      <PostTown>string</PostTown>
      <DependentLocality>string</DependentLocality>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <AddressKey>int</AddressKey>
      <NumberOfHouseholds>int</NumberOfHouseholds>
      <CSV>
        <AddressKey>int</AddressKey>
        <SummaryAddress>string</SummaryAddress>
      </CSV>
      <Summary2>
        <string>string</string>
        <string>string</string>
      </Summary2>
    </PafAddress>
  </Results>
</PafAddressResponse>