PowerSuiteWebService Web Service

PowerSuiteWebService

Click here for a complete list of operations.

GetCollectionSlots

Returns all available ad hoc collection info in PowerSuite given a site id or uprn and service id

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

<?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>
    <GetCollectionSlots xmlns="http://webservices.whitespacews.com/">
      <collectionSlotsInputInput>
        <NextCollectionFromDate>string</NextCollectionFromDate>
        <NextCollectionToDate>string</NextCollectionToDate>
        <ListCount>string</ListCount>
      </collectionSlotsInputInput>
    </GetCollectionSlots>
  </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>
    <GetCollectionSlotsResponse xmlns="http://webservices.whitespacews.com/">
      <GetCollectionSlotsResult>
        <ApiAdHocRoundInstances>
          <ApiAdHocRoundInstance>
            <SlotsFree>int</SlotsFree>
            <SlotsTaken>int</SlotsTaken>
          </ApiAdHocRoundInstance>
          <ApiAdHocRoundInstance>
            <SlotsFree>int</SlotsFree>
            <SlotsTaken>int</SlotsTaken>
          </ApiAdHocRoundInstance>
        </ApiAdHocRoundInstances>
      </GetCollectionSlotsResult>
    </GetCollectionSlotsResponse>
  </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>
    <GetCollectionSlots xmlns="http://webservices.whitespacews.com/">
      <collectionSlotsInputInput>
        <NextCollectionFromDate>string</NextCollectionFromDate>
        <NextCollectionToDate>string</NextCollectionToDate>
        <ListCount>string</ListCount>
      </collectionSlotsInputInput>
    </GetCollectionSlots>
  </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>
    <GetCollectionSlotsResponse xmlns="http://webservices.whitespacews.com/">
      <GetCollectionSlotsResult>
        <ApiAdHocRoundInstances>
          <ApiAdHocRoundInstance>
            <SlotsFree>int</SlotsFree>
            <SlotsTaken>int</SlotsTaken>
          </ApiAdHocRoundInstance>
          <ApiAdHocRoundInstance>
            <SlotsFree>int</SlotsFree>
            <SlotsTaken>int</SlotsTaken>
          </ApiAdHocRoundInstance>
        </ApiAdHocRoundInstances>
      </GetCollectionSlotsResult>
    </GetCollectionSlotsResponse>
  </soap12:Body>
</soap12:Envelope>