PowerSuiteWebService


Click here for a complete list of operations.

GetSiteWorksheets

Returns all worksheets for a site in PowerSuite given an account 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/GetSiteWorksheets"

<?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>
    <GetSiteWorksheets xmlns="http://webservices.whitespacews.com/">
      <worksheetInput>
        <WorksheetSortOrder>WorksheetCreatedDate or WorksheetDueByDate or WorksheetStartDate or None</WorksheetSortOrder>
        <OrderAscending>boolean</OrderAscending>
        <WorksheetFilter>WorksheetSubject or WorksheetCreatedBy or WorksheetAssignedToName or AuthorityName or WorksheetStatusName or None</WorksheetFilter>
        <WorksheetFilterString>string</WorksheetFilterString>
      </worksheetInput>
    </GetSiteWorksheets>
  </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>
    <GetSiteWorksheetsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteWorksheetsResult>
        <Worksheets>
          <Worksheet>
            <AuthorityID>int</AuthorityID>
            <AuthorityName>string</AuthorityName>
            <WorkflowInstanceID>int</WorkflowInstanceID>
            <InstanceGuid>guid</InstanceGuid>
            <WorkflowFileID>int</WorkflowFileID>
            <WorkflowFileName>string</WorkflowFileName>
            <WorkflowFileXaml>string</WorkflowFileXaml>
            <InstanceCurrentState>string</InstanceCurrentState>
          </Worksheet>
          <Worksheet>
            <AuthorityID>int</AuthorityID>
            <AuthorityName>string</AuthorityName>
            <WorkflowInstanceID>int</WorkflowInstanceID>
            <InstanceGuid>guid</InstanceGuid>
            <WorkflowFileID>int</WorkflowFileID>
            <WorkflowFileName>string</WorkflowFileName>
            <WorkflowFileXaml>string</WorkflowFileXaml>
            <InstanceCurrentState>string</InstanceCurrentState>
          </Worksheet>
        </Worksheets>
      </GetSiteWorksheetsResult>
    </GetSiteWorksheetsResponse>
  </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>
    <GetSiteWorksheets xmlns="http://webservices.whitespacews.com/">
      <worksheetInput>
        <WorksheetSortOrder>WorksheetCreatedDate or WorksheetDueByDate or WorksheetStartDate or None</WorksheetSortOrder>
        <OrderAscending>boolean</OrderAscending>
        <WorksheetFilter>WorksheetSubject or WorksheetCreatedBy or WorksheetAssignedToName or AuthorityName or WorksheetStatusName or None</WorksheetFilter>
        <WorksheetFilterString>string</WorksheetFilterString>
      </worksheetInput>
    </GetSiteWorksheets>
  </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>
    <GetSiteWorksheetsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteWorksheetsResult>
        <Worksheets>
          <Worksheet>
            <AuthorityID>int</AuthorityID>
            <AuthorityName>string</AuthorityName>
            <WorkflowInstanceID>int</WorkflowInstanceID>
            <InstanceGuid>guid</InstanceGuid>
            <WorkflowFileID>int</WorkflowFileID>
            <WorkflowFileName>string</WorkflowFileName>
            <WorkflowFileXaml>string</WorkflowFileXaml>
            <InstanceCurrentState>string</InstanceCurrentState>
          </Worksheet>
          <Worksheet>
            <AuthorityID>int</AuthorityID>
            <AuthorityName>string</AuthorityName>
            <WorkflowInstanceID>int</WorkflowInstanceID>
            <InstanceGuid>guid</InstanceGuid>
            <WorkflowFileID>int</WorkflowFileID>
            <WorkflowFileName>string</WorkflowFileName>
            <WorkflowFileXaml>string</WorkflowFileXaml>
            <InstanceCurrentState>string</InstanceCurrentState>
          </Worksheet>
        </Worksheets>
      </GetSiteWorksheetsResult>
    </GetSiteWorksheetsResponse>
  </soap12:Body>
</soap12:Envelope>