PowerSuiteWebService


Click here for a complete list of operations.

GetActiveAddresses

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 /PowerSuiteDomesticWebService.asmx HTTP/1.1
Host: udtapi-municipal-test.whitespacews.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservices.whitespacews.com/GetActiveAddresses"

<?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>
    <GetActiveAddresses xmlns="http://webservices.whitespacews.com/">
      <getActiveAddressInput>
        <AddressNameNumber>string</AddressNameNumber>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <Town>string</Town>
        <County>string</County>
        <Country>string</Country>
        <Postcode>string</Postcode>
        <IncludeCommercialSites>boolean</IncludeCommercialSites>
      </getActiveAddressInput>
    </GetActiveAddresses>
  </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>
    <GetActiveAddressesResponse xmlns="http://webservices.whitespacews.com/">
      <GetActiveAddressesResult>
        <Addresses>
          <Address>
            <SiteShortAddress>string</SiteShortAddress>
            <SiteName>string</SiteName>
            <SiteAddressName>string</SiteAddressName>
            <SiteAddressPrefix>string</SiteAddressPrefix>
            <SiteAddressNumber>string</SiteAddressNumber>
            <SiteAddress1>string</SiteAddress1>
            <SiteAddress2>string</SiteAddress2>
            <SiteTown>string</SiteTown>
            <SiteCity>string</SiteCity>
            <SiteCounty>string</SiteCounty>
            <SiteCountry>string</SiteCountry>
            <SitePostCode>string</SitePostCode>
            <SiteLatitude>double</SiteLatitude>
            <SiteLongitude>double</SiteLongitude>
            <SiteNorthing>double</SiteNorthing>
            <SiteEasting>double</SiteEasting>
            <AccountSiteUprn>decimal</AccountSiteUprn>
            <SiteId>int</SiteId>
            <AccountSiteId>int</AccountSiteId>
          </Address>
          <Address>
            <SiteShortAddress>string</SiteShortAddress>
            <SiteName>string</SiteName>
            <SiteAddressName>string</SiteAddressName>
            <SiteAddressPrefix>string</SiteAddressPrefix>
            <SiteAddressNumber>string</SiteAddressNumber>
            <SiteAddress1>string</SiteAddress1>
            <SiteAddress2>string</SiteAddress2>
            <SiteTown>string</SiteTown>
            <SiteCity>string</SiteCity>
            <SiteCounty>string</SiteCounty>
            <SiteCountry>string</SiteCountry>
            <SitePostCode>string</SitePostCode>
            <SiteLatitude>double</SiteLatitude>
            <SiteLongitude>double</SiteLongitude>
            <SiteNorthing>double</SiteNorthing>
            <SiteEasting>double</SiteEasting>
            <AccountSiteUprn>decimal</AccountSiteUprn>
            <SiteId>int</SiteId>
            <AccountSiteId>int</AccountSiteId>
          </Address>
        </Addresses>
      </GetActiveAddressesResult>
    </GetActiveAddressesResponse>
  </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 /PowerSuiteDomesticWebService.asmx HTTP/1.1
Host: udtapi-municipal-test.whitespacews.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>
    <GetActiveAddresses xmlns="http://webservices.whitespacews.com/">
      <getActiveAddressInput>
        <AddressNameNumber>string</AddressNameNumber>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <Town>string</Town>
        <County>string</County>
        <Country>string</Country>
        <Postcode>string</Postcode>
        <IncludeCommercialSites>boolean</IncludeCommercialSites>
      </getActiveAddressInput>
    </GetActiveAddresses>
  </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>
    <GetActiveAddressesResponse xmlns="http://webservices.whitespacews.com/">
      <GetActiveAddressesResult>
        <Addresses>
          <Address>
            <SiteShortAddress>string</SiteShortAddress>
            <SiteName>string</SiteName>
            <SiteAddressName>string</SiteAddressName>
            <SiteAddressPrefix>string</SiteAddressPrefix>
            <SiteAddressNumber>string</SiteAddressNumber>
            <SiteAddress1>string</SiteAddress1>
            <SiteAddress2>string</SiteAddress2>
            <SiteTown>string</SiteTown>
            <SiteCity>string</SiteCity>
            <SiteCounty>string</SiteCounty>
            <SiteCountry>string</SiteCountry>
            <SitePostCode>string</SitePostCode>
            <SiteLatitude>double</SiteLatitude>
            <SiteLongitude>double</SiteLongitude>
            <SiteNorthing>double</SiteNorthing>
            <SiteEasting>double</SiteEasting>
            <AccountSiteUprn>decimal</AccountSiteUprn>
            <SiteId>int</SiteId>
            <AccountSiteId>int</AccountSiteId>
          </Address>
          <Address>
            <SiteShortAddress>string</SiteShortAddress>
            <SiteName>string</SiteName>
            <SiteAddressName>string</SiteAddressName>
            <SiteAddressPrefix>string</SiteAddressPrefix>
            <SiteAddressNumber>string</SiteAddressNumber>
            <SiteAddress1>string</SiteAddress1>
            <SiteAddress2>string</SiteAddress2>
            <SiteTown>string</SiteTown>
            <SiteCity>string</SiteCity>
            <SiteCounty>string</SiteCounty>
            <SiteCountry>string</SiteCountry>
            <SitePostCode>string</SitePostCode>
            <SiteLatitude>double</SiteLatitude>
            <SiteLongitude>double</SiteLongitude>
            <SiteNorthing>double</SiteNorthing>
            <SiteEasting>double</SiteEasting>
            <AccountSiteUprn>decimal</AccountSiteUprn>
            <SiteId>int</SiteId>
            <AccountSiteId>int</AccountSiteId>
          </Address>
        </Addresses>
      </GetActiveAddressesResult>
    </GetActiveAddressesResponse>
  </soap12:Body>
</soap12:Envelope>