PowerSuiteWebService Web Service

PowerSuiteWebService

Click here for a complete list of operations.

GetSiteCollections

Returns all collections for a site in PowerSuite given a site id or uprn

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

<?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>
    <GetSiteCollections xmlns="http://webservices.whitespacews.com/">
      <siteserviceInput>
        <IncludeCommercial>boolean</IncludeCommercial>
      </siteserviceInput>
    </GetSiteCollections>
  </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>
    <GetSiteCollectionsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteCollectionsResult>
        <SiteServices>
          <SiteService>
            <ExtensionData xsi:nil="true" />
            <SiteServiceID>int</SiteServiceID>
            <SiteID>int</SiteID>
            <AccountSiteID>int</AccountSiteID>
            <ServiceItemID>int</ServiceItemID>
            <ServiceItemName>string</ServiceItemName>
            <ServiceItemDescription>string</ServiceItemDescription>
            <ServiceItemSerialNumber>string</ServiceItemSerialNumber>
            <ServiceItemChipNumber>string</ServiceItemChipNumber>
            <ServiceItemUniqueNumber>string</ServiceItemUniqueNumber>
            <SiteServiceValidFrom>dateTime</SiteServiceValidFrom>
            <ContractValidTo>dateTime</ContractValidTo>
            <SiteServiceValidTo>dateTime</SiteServiceValidTo>
            <SiteServiceBlockedFrom>dateTime</SiteServiceBlockedFrom>
            <SiteServiceNotes>string</SiteServiceNotes>
            <ServiceID>int</ServiceID>
            <ServiceName>string</ServiceName>
            <ServiceDescription>string</ServiceDescription>
            <ContractID>int</ContractID>
            <ContractName>string</ContractName>
            <ContractDescription>string</ContractDescription>
            <ContractValidFrom>dateTime</ContractValidFrom>
            <ContractTypeID>int</ContractTypeID>
            <ContractTypeName>string</ContractTypeName>
            <ContractTypeDescription>string</ContractTypeDescription>
            <Quantity>int</Quantity>
            <Charge>double</Charge>
            <Cost>double</Cost>
            <CSSIValidFrom>dateTime</CSSIValidFrom>
            <CSSIValidTo>dateTime</CSSIValidTo>
            <ProductCode>string</ProductCode>
            <ChargeTypeID>int</ChargeTypeID>
            <ChargeTypeName>string</ChargeTypeName>
            <PerCollection>boolean</PerCollection>
            <PerLift>boolean</PerLift>
            <PerKg>boolean</PerKg>
            <PaymentScheduleID>int</PaymentScheduleID>
            <PaymentScheduleName>string</PaymentScheduleName>
            <PaymentScheduleDescription>string</PaymentScheduleDescription>
            <PaymentMethodID>int</PaymentMethodID>
            <PaymentMethodName>string</PaymentMethodName>
            <PaymentMethodDescription>string</PaymentMethodDescription>
            <GenerateTransaction>boolean</GenerateTransaction>
            <RoundSchedule>string</RoundSchedule>
            <SiteContractID>int</SiteContractID>
            <ContractStatusCode>string</ContractStatusCode>
            <EWCCode>string</EWCCode>
            <SiteServiceItemQuantity>decimal</SiteServiceItemQuantity>
            <SiteServiceItemID>int</SiteServiceItemID>
            <NextCollectionDate>dateTime</NextCollectionDate>
          </SiteService>
          <SiteService>
            <ExtensionData xsi:nil="true" />
            <SiteServiceID>int</SiteServiceID>
            <SiteID>int</SiteID>
            <AccountSiteID>int</AccountSiteID>
            <ServiceItemID>int</ServiceItemID>
            <ServiceItemName>string</ServiceItemName>
            <ServiceItemDescription>string</ServiceItemDescription>
            <ServiceItemSerialNumber>string</ServiceItemSerialNumber>
            <ServiceItemChipNumber>string</ServiceItemChipNumber>
            <ServiceItemUniqueNumber>string</ServiceItemUniqueNumber>
            <SiteServiceValidFrom>dateTime</SiteServiceValidFrom>
            <ContractValidTo>dateTime</ContractValidTo>
            <SiteServiceValidTo>dateTime</SiteServiceValidTo>
            <SiteServiceBlockedFrom>dateTime</SiteServiceBlockedFrom>
            <SiteServiceNotes>string</SiteServiceNotes>
            <ServiceID>int</ServiceID>
            <ServiceName>string</ServiceName>
            <ServiceDescription>string</ServiceDescription>
            <ContractID>int</ContractID>
            <ContractName>string</ContractName>
            <ContractDescription>string</ContractDescription>
            <ContractValidFrom>dateTime</ContractValidFrom>
            <ContractTypeID>int</ContractTypeID>
            <ContractTypeName>string</ContractTypeName>
            <ContractTypeDescription>string</ContractTypeDescription>
            <Quantity>int</Quantity>
            <Charge>double</Charge>
            <Cost>double</Cost>
            <CSSIValidFrom>dateTime</CSSIValidFrom>
            <CSSIValidTo>dateTime</CSSIValidTo>
            <ProductCode>string</ProductCode>
            <ChargeTypeID>int</ChargeTypeID>
            <ChargeTypeName>string</ChargeTypeName>
            <PerCollection>boolean</PerCollection>
            <PerLift>boolean</PerLift>
            <PerKg>boolean</PerKg>
            <PaymentScheduleID>int</PaymentScheduleID>
            <PaymentScheduleName>string</PaymentScheduleName>
            <PaymentScheduleDescription>string</PaymentScheduleDescription>
            <PaymentMethodID>int</PaymentMethodID>
            <PaymentMethodName>string</PaymentMethodName>
            <PaymentMethodDescription>string</PaymentMethodDescription>
            <GenerateTransaction>boolean</GenerateTransaction>
            <RoundSchedule>string</RoundSchedule>
            <SiteContractID>int</SiteContractID>
            <ContractStatusCode>string</ContractStatusCode>
            <EWCCode>string</EWCCode>
            <SiteServiceItemQuantity>decimal</SiteServiceItemQuantity>
            <SiteServiceItemID>int</SiteServiceItemID>
            <NextCollectionDate>dateTime</NextCollectionDate>
          </SiteService>
        </SiteServices>
      </GetSiteCollectionsResult>
    </GetSiteCollectionsResponse>
  </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>
    <GetSiteCollections xmlns="http://webservices.whitespacews.com/">
      <siteserviceInput>
        <IncludeCommercial>boolean</IncludeCommercial>
      </siteserviceInput>
    </GetSiteCollections>
  </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>
    <GetSiteCollectionsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteCollectionsResult>
        <SiteServices>
          <SiteService>
            <ExtensionData xsi:nil="true" />
            <SiteServiceID>int</SiteServiceID>
            <SiteID>int</SiteID>
            <AccountSiteID>int</AccountSiteID>
            <ServiceItemID>int</ServiceItemID>
            <ServiceItemName>string</ServiceItemName>
            <ServiceItemDescription>string</ServiceItemDescription>
            <ServiceItemSerialNumber>string</ServiceItemSerialNumber>
            <ServiceItemChipNumber>string</ServiceItemChipNumber>
            <ServiceItemUniqueNumber>string</ServiceItemUniqueNumber>
            <SiteServiceValidFrom>dateTime</SiteServiceValidFrom>
            <ContractValidTo>dateTime</ContractValidTo>
            <SiteServiceValidTo>dateTime</SiteServiceValidTo>
            <SiteServiceBlockedFrom>dateTime</SiteServiceBlockedFrom>
            <SiteServiceNotes>string</SiteServiceNotes>
            <ServiceID>int</ServiceID>
            <ServiceName>string</ServiceName>
            <ServiceDescription>string</ServiceDescription>
            <ContractID>int</ContractID>
            <ContractName>string</ContractName>
            <ContractDescription>string</ContractDescription>
            <ContractValidFrom>dateTime</ContractValidFrom>
            <ContractTypeID>int</ContractTypeID>
            <ContractTypeName>string</ContractTypeName>
            <ContractTypeDescription>string</ContractTypeDescription>
            <Quantity>int</Quantity>
            <Charge>double</Charge>
            <Cost>double</Cost>
            <CSSIValidFrom>dateTime</CSSIValidFrom>
            <CSSIValidTo>dateTime</CSSIValidTo>
            <ProductCode>string</ProductCode>
            <ChargeTypeID>int</ChargeTypeID>
            <ChargeTypeName>string</ChargeTypeName>
            <PerCollection>boolean</PerCollection>
            <PerLift>boolean</PerLift>
            <PerKg>boolean</PerKg>
            <PaymentScheduleID>int</PaymentScheduleID>
            <PaymentScheduleName>string</PaymentScheduleName>
            <PaymentScheduleDescription>string</PaymentScheduleDescription>
            <PaymentMethodID>int</PaymentMethodID>
            <PaymentMethodName>string</PaymentMethodName>
            <PaymentMethodDescription>string</PaymentMethodDescription>
            <GenerateTransaction>boolean</GenerateTransaction>
            <RoundSchedule>string</RoundSchedule>
            <SiteContractID>int</SiteContractID>
            <ContractStatusCode>string</ContractStatusCode>
            <EWCCode>string</EWCCode>
            <SiteServiceItemQuantity>decimal</SiteServiceItemQuantity>
            <SiteServiceItemID>int</SiteServiceItemID>
            <NextCollectionDate>dateTime</NextCollectionDate>
          </SiteService>
          <SiteService>
            <ExtensionData xsi:nil="true" />
            <SiteServiceID>int</SiteServiceID>
            <SiteID>int</SiteID>
            <AccountSiteID>int</AccountSiteID>
            <ServiceItemID>int</ServiceItemID>
            <ServiceItemName>string</ServiceItemName>
            <ServiceItemDescription>string</ServiceItemDescription>
            <ServiceItemSerialNumber>string</ServiceItemSerialNumber>
            <ServiceItemChipNumber>string</ServiceItemChipNumber>
            <ServiceItemUniqueNumber>string</ServiceItemUniqueNumber>
            <SiteServiceValidFrom>dateTime</SiteServiceValidFrom>
            <ContractValidTo>dateTime</ContractValidTo>
            <SiteServiceValidTo>dateTime</SiteServiceValidTo>
            <SiteServiceBlockedFrom>dateTime</SiteServiceBlockedFrom>
            <SiteServiceNotes>string</SiteServiceNotes>
            <ServiceID>int</ServiceID>
            <ServiceName>string</ServiceName>
            <ServiceDescription>string</ServiceDescription>
            <ContractID>int</ContractID>
            <ContractName>string</ContractName>
            <ContractDescription>string</ContractDescription>
            <ContractValidFrom>dateTime</ContractValidFrom>
            <ContractTypeID>int</ContractTypeID>
            <ContractTypeName>string</ContractTypeName>
            <ContractTypeDescription>string</ContractTypeDescription>
            <Quantity>int</Quantity>
            <Charge>double</Charge>
            <Cost>double</Cost>
            <CSSIValidFrom>dateTime</CSSIValidFrom>
            <CSSIValidTo>dateTime</CSSIValidTo>
            <ProductCode>string</ProductCode>
            <ChargeTypeID>int</ChargeTypeID>
            <ChargeTypeName>string</ChargeTypeName>
            <PerCollection>boolean</PerCollection>
            <PerLift>boolean</PerLift>
            <PerKg>boolean</PerKg>
            <PaymentScheduleID>int</PaymentScheduleID>
            <PaymentScheduleName>string</PaymentScheduleName>
            <PaymentScheduleDescription>string</PaymentScheduleDescription>
            <PaymentMethodID>int</PaymentMethodID>
            <PaymentMethodName>string</PaymentMethodName>
            <PaymentMethodDescription>string</PaymentMethodDescription>
            <GenerateTransaction>boolean</GenerateTransaction>
            <RoundSchedule>string</RoundSchedule>
            <SiteContractID>int</SiteContractID>
            <ContractStatusCode>string</ContractStatusCode>
            <EWCCode>string</EWCCode>
            <SiteServiceItemQuantity>decimal</SiteServiceItemQuantity>
            <SiteServiceItemID>int</SiteServiceItemID>
            <NextCollectionDate>dateTime</NextCollectionDate>
          </SiteService>
        </SiteServices>
      </GetSiteCollectionsResult>
    </GetSiteCollectionsResponse>
  </soap12:Body>
</soap12:Envelope>