PowerSuiteWebService


Click here for a complete list of operations.

GetFullSiteCollections

Returns all collections for a site in PowerSuite given a site id or uprn as well as round schedules and extra details

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/GetFullSiteCollections"

<?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>
    <GetFullSiteCollections xmlns="http://webservices.whitespacews.com/">
      <siteserviceInput>
        <IncludeCommercial>boolean</IncludeCommercial>
      </siteserviceInput>
    </GetFullSiteCollections>
  </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>
    <GetFullSiteCollectionsResponse xmlns="http://webservices.whitespacews.com/">
      <GetFullSiteCollectionsResult>
        <SiteServices>
          <ApiSiteServiceWithExtraDetails>
            <SiteService xsi:nil="true" />
            <SiteServiceSiteServiceItemServiceItemProperties xsi:nil="true" />
            <RRASSContractRounds xsi:nil="true" />
          </ApiSiteServiceWithExtraDetails>
          <ApiSiteServiceWithExtraDetails>
            <SiteService xsi:nil="true" />
            <SiteServiceSiteServiceItemServiceItemProperties xsi:nil="true" />
            <RRASSContractRounds xsi:nil="true" />
          </ApiSiteServiceWithExtraDetails>
        </SiteServices>
      </GetFullSiteCollectionsResult>
    </GetFullSiteCollectionsResponse>
  </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>
    <GetFullSiteCollections xmlns="http://webservices.whitespacews.com/">
      <siteserviceInput>
        <IncludeCommercial>boolean</IncludeCommercial>
      </siteserviceInput>
    </GetFullSiteCollections>
  </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>
    <GetFullSiteCollectionsResponse xmlns="http://webservices.whitespacews.com/">
      <GetFullSiteCollectionsResult>
        <SiteServices>
          <ApiSiteServiceWithExtraDetails>
            <SiteService xsi:nil="true" />
            <SiteServiceSiteServiceItemServiceItemProperties xsi:nil="true" />
            <RRASSContractRounds xsi:nil="true" />
          </ApiSiteServiceWithExtraDetails>
          <ApiSiteServiceWithExtraDetails>
            <SiteService xsi:nil="true" />
            <SiteServiceSiteServiceItemServiceItemProperties xsi:nil="true" />
            <RRASSContractRounds xsi:nil="true" />
          </ApiSiteServiceWithExtraDetails>
        </SiteServices>
      </GetFullSiteCollectionsResult>
    </GetFullSiteCollectionsResponse>
  </soap12:Body>
</soap12:Envelope>