PowerSuiteWebService


Click here for a complete list of operations.

GetWorksheetDetails

Returns basic worksheet info in PowerSuite given a worksheet 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/GetWorksheetDetails"

<?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>
    <GetWorksheetDetails xmlns="http://webservices.whitespacews.com/">
      <worksheetDetailsInput />
    </GetWorksheetDetails>
  </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>
    <GetWorksheetDetailsResponse xmlns="http://webservices.whitespacews.com/">
      <GetWorksheetDetailsResult>
        <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>
      </GetWorksheetDetailsResult>
    </GetWorksheetDetailsResponse>
  </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>
    <GetWorksheetDetails xmlns="http://webservices.whitespacews.com/">
      <worksheetDetailsInput />
    </GetWorksheetDetails>
  </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>
    <GetWorksheetDetailsResponse xmlns="http://webservices.whitespacews.com/">
      <GetWorksheetDetailsResult>
        <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>
      </GetWorksheetDetailsResult>
    </GetWorksheetDetailsResponse>
  </soap12:Body>
</soap12:Envelope>