PowerSuiteWebService Web Service

PowerSuiteWebService

Click here for a complete list of operations.

CreateWorksheet

Creates a worksheet in PowerSuite

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

<?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>
    <CreateWorksheet xmlns="http://webservices.whitespacews.com/">
      <worksheetInput>
        <Uprn>string</Uprn>
        <AccountSiteId>string</AccountSiteId>
        <Usrn>string</Usrn>
        <ServiceId>string</ServiceId>
        <WorksheetReference>string</WorksheetReference>
        <WorksheetMessage>string</WorksheetMessage>
        <WorkLocationAddress>string</WorkLocationAddress>
        <WorkLocationName>string</WorkLocationName>
        <WorkLocationLatitude>string</WorkLocationLatitude>
        <WorkLocationLongitude>string</WorkLocationLongitude>
        <WorkLocationNorthing>string</WorkLocationNorthing>
        <WorkLocationEasting>string</WorkLocationEasting>
        <WorksheetStartDate>string</WorksheetStartDate>
        <WorksheetDueDate>string</WorksheetDueDate>
        <ServiceItemInputs>
          <ServiceItemInput>
            <ServiceItemId>int</ServiceItemId>
            <ServiceItemName>string</ServiceItemName>
            <ServiceItemQuantity>decimal</ServiceItemQuantity>
          </ServiceItemInput>
          <ServiceItemInput>
            <ServiceItemId>int</ServiceItemId>
            <ServiceItemName>string</ServiceItemName>
            <ServiceItemQuantity>decimal</ServiceItemQuantity>
          </ServiceItemInput>
        </ServiceItemInputs>
        <ServicePropertyInputs>
          <ServicePropertyInput>
            <ServicePropertyId>int</ServicePropertyId>
            <ServicePropertyValue>string</ServicePropertyValue>
          </ServicePropertyInput>
          <ServicePropertyInput>
            <ServicePropertyId>int</ServicePropertyId>
            <ServicePropertyValue>string</ServicePropertyValue>
          </ServicePropertyInput>
        </ServicePropertyInputs>
        <AdHocRoundInstanceId>string</AdHocRoundInstanceId>
        <RoleId>int</RoleId>
        <RoleName>string</RoleName>
      </worksheetInput>
    </CreateWorksheet>
  </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>
    <CreateWorksheetResponse xmlns="http://webservices.whitespacews.com/">
      <CreateWorksheetResult>
        <WorksheetResponse>
          <anyType />
          <anyType />
        </WorksheetResponse>
      </CreateWorksheetResult>
    </CreateWorksheetResponse>
  </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>
    <CreateWorksheet xmlns="http://webservices.whitespacews.com/">
      <worksheetInput>
        <Uprn>string</Uprn>
        <AccountSiteId>string</AccountSiteId>
        <Usrn>string</Usrn>
        <ServiceId>string</ServiceId>
        <WorksheetReference>string</WorksheetReference>
        <WorksheetMessage>string</WorksheetMessage>
        <WorkLocationAddress>string</WorkLocationAddress>
        <WorkLocationName>string</WorkLocationName>
        <WorkLocationLatitude>string</WorkLocationLatitude>
        <WorkLocationLongitude>string</WorkLocationLongitude>
        <WorkLocationNorthing>string</WorkLocationNorthing>
        <WorkLocationEasting>string</WorkLocationEasting>
        <WorksheetStartDate>string</WorksheetStartDate>
        <WorksheetDueDate>string</WorksheetDueDate>
        <ServiceItemInputs>
          <ServiceItemInput>
            <ServiceItemId>int</ServiceItemId>
            <ServiceItemName>string</ServiceItemName>
            <ServiceItemQuantity>decimal</ServiceItemQuantity>
          </ServiceItemInput>
          <ServiceItemInput>
            <ServiceItemId>int</ServiceItemId>
            <ServiceItemName>string</ServiceItemName>
            <ServiceItemQuantity>decimal</ServiceItemQuantity>
          </ServiceItemInput>
        </ServiceItemInputs>
        <ServicePropertyInputs>
          <ServicePropertyInput>
            <ServicePropertyId>int</ServicePropertyId>
            <ServicePropertyValue>string</ServicePropertyValue>
          </ServicePropertyInput>
          <ServicePropertyInput>
            <ServicePropertyId>int</ServicePropertyId>
            <ServicePropertyValue>string</ServicePropertyValue>
          </ServicePropertyInput>
        </ServicePropertyInputs>
        <AdHocRoundInstanceId>string</AdHocRoundInstanceId>
        <RoleId>int</RoleId>
        <RoleName>string</RoleName>
      </worksheetInput>
    </CreateWorksheet>
  </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>
    <CreateWorksheetResponse xmlns="http://webservices.whitespacews.com/">
      <CreateWorksheetResult>
        <WorksheetResponse>
          <anyType />
          <anyType />
        </WorksheetResponse>
      </CreateWorksheetResult>
    </CreateWorksheetResponse>
  </soap12:Body>
</soap12:Envelope>