PowerSuiteWebService Web Service

PowerSuiteWebService

Click here for a complete list of operations.

UpdateWorksheet

Modifies an existing worksheet given the updated data

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

<?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>
    <UpdateWorksheet xmlns="http://webservices.whitespacews.com/">
      <worksheetDetailInput>
        <WorksheetId>string</WorksheetId>
        <WorksheetReference>string</WorksheetReference>
        <WorksheetSubject>string</WorksheetSubject>
        <WorksheetMessage>string</WorksheetMessage>
        <WorksheetAssignedToID>string</WorksheetAssignedToID>
        <WorksheetAssignedToTypeID>string</WorksheetAssignedToTypeID>
        <WorkLocationAddressID>string</WorkLocationAddressID>
        <WorkLocationAddress>string</WorkLocationAddress>
        <WorkLocationName>string</WorkLocationName>
        <WorkLocationText>string</WorkLocationText>
        <WorkLocationLatitude>string</WorkLocationLatitude>
        <WorkLocationLongitude>string</WorkLocationLongitude>
        <WorkLocationNorthing>string</WorkLocationNorthing>
        <WorkLocationEasting>string</WorkLocationEasting>
        <WorksheetDueDate>string</WorksheetDueDate>
        <WorksheetImportanceID>string</WorksheetImportanceID>
        <WorksheetEscallatedDate>string</WorksheetEscallatedDate>
        <WorksheetCompletedDate>string</WorksheetCompletedDate>
        <WorksheetApprovedDate>string</WorksheetApprovedDate>
        <WorksheetPaymentDate>string</WorksheetPaymentDate>
        <WorksheetExpiryDate>string</WorksheetExpiryDate>
        <ServicePropertyInputs>
          <UpdateServicePropertyInput>
            <ServicePropertyId>int</ServicePropertyId>
            <ServicePropertyValue>string</ServicePropertyValue>
          </UpdateServicePropertyInput>
          <UpdateServicePropertyInput>
            <ServicePropertyId>int</ServicePropertyId>
            <ServicePropertyValue>string</ServicePropertyValue>
          </UpdateServicePropertyInput>
        </ServicePropertyInputs>
      </worksheetDetailInput>
    </UpdateWorksheet>
  </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>
    <UpdateWorksheetResponse xmlns="http://webservices.whitespacews.com/">
      <UpdateWorksheetResult>
        <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>
      </UpdateWorksheetResult>
    </UpdateWorksheetResponse>
  </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>
    <UpdateWorksheet xmlns="http://webservices.whitespacews.com/">
      <worksheetDetailInput>
        <WorksheetId>string</WorksheetId>
        <WorksheetReference>string</WorksheetReference>
        <WorksheetSubject>string</WorksheetSubject>
        <WorksheetMessage>string</WorksheetMessage>
        <WorksheetAssignedToID>string</WorksheetAssignedToID>
        <WorksheetAssignedToTypeID>string</WorksheetAssignedToTypeID>
        <WorkLocationAddressID>string</WorkLocationAddressID>
        <WorkLocationAddress>string</WorkLocationAddress>
        <WorkLocationName>string</WorkLocationName>
        <WorkLocationText>string</WorkLocationText>
        <WorkLocationLatitude>string</WorkLocationLatitude>
        <WorkLocationLongitude>string</WorkLocationLongitude>
        <WorkLocationNorthing>string</WorkLocationNorthing>
        <WorkLocationEasting>string</WorkLocationEasting>
        <WorksheetDueDate>string</WorksheetDueDate>
        <WorksheetImportanceID>string</WorksheetImportanceID>
        <WorksheetEscallatedDate>string</WorksheetEscallatedDate>
        <WorksheetCompletedDate>string</WorksheetCompletedDate>
        <WorksheetApprovedDate>string</WorksheetApprovedDate>
        <WorksheetPaymentDate>string</WorksheetPaymentDate>
        <WorksheetExpiryDate>string</WorksheetExpiryDate>
        <ServicePropertyInputs>
          <UpdateServicePropertyInput>
            <ServicePropertyId>int</ServicePropertyId>
            <ServicePropertyValue>string</ServicePropertyValue>
          </UpdateServicePropertyInput>
          <UpdateServicePropertyInput>
            <ServicePropertyId>int</ServicePropertyId>
            <ServicePropertyValue>string</ServicePropertyValue>
          </UpdateServicePropertyInput>
        </ServicePropertyInputs>
      </worksheetDetailInput>
    </UpdateWorksheet>
  </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>
    <UpdateWorksheetResponse xmlns="http://webservices.whitespacews.com/">
      <UpdateWorksheetResult>
        <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>
      </UpdateWorksheetResult>
    </UpdateWorksheetResponse>
  </soap12:Body>
</soap12:Envelope>