PowerSuiteWebService Web Service

PowerSuiteWebService

Click here for a complete list of operations.

GetSiteContracts

Returns all contracts 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/GetSiteContracts"

<?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>
    <GetSiteContracts xmlns="http://webservices.whitespacews.com/">
      <sitecontractInput>
        <IncludeCommercial>boolean</IncludeCommercial>
      </sitecontractInput>
    </GetSiteContracts>
  </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>
    <GetSiteContractsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteContractsResult>
        <SiteContracts>
          <SiteContract>
            <ExtensionData xsi:nil="true" />
            <SiteContractID>int</SiteContractID>
            <SiteID>int</SiteID>
            <AccountSiteID>int</AccountSiteID>
            <ContractID>int</ContractID>
            <ContractTypeID>int</ContractTypeID>
            <ContractTypeName>string</ContractTypeName>
            <ContractStatusCode>string</ContractStatusCode>
            <ContractStatusDescription>string</ContractStatusDescription>
            <ContractName>string</ContractName>
            <SiteContractValidFrom>dateTime</SiteContractValidFrom>
            <SiteContractValidTo>dateTime</SiteContractValidTo>
            <ScheduleID>int</ScheduleID>
            <ScheduleName>string</ScheduleName>
            <PaymentMethodID>int</PaymentMethodID>
            <PaymentMethodName>string</PaymentMethodName>
            <SiteContractGUID>string</SiteContractGUID>
            <ContractReference>string</ContractReference>
            <ContractPONumber>string</ContractPONumber>
            <SiteContractNotes>string</SiteContractNotes>
            <SiteAddress>string</SiteAddress>
            <SelectedEndDate>dateTime</SelectedEndDate>
            <InvoiceToDate>dateTime</InvoiceToDate>
            <WorkflowInstanceID>int</WorkflowInstanceID>
            <InstanceGuid>guid</InstanceGuid>
            <WorkflowFileID>int</WorkflowFileID>
            <WorkflowFileName>string</WorkflowFileName>
            <InstanceCurrentState>string</InstanceCurrentState>
          </SiteContract>
          <SiteContract>
            <ExtensionData xsi:nil="true" />
            <SiteContractID>int</SiteContractID>
            <SiteID>int</SiteID>
            <AccountSiteID>int</AccountSiteID>
            <ContractID>int</ContractID>
            <ContractTypeID>int</ContractTypeID>
            <ContractTypeName>string</ContractTypeName>
            <ContractStatusCode>string</ContractStatusCode>
            <ContractStatusDescription>string</ContractStatusDescription>
            <ContractName>string</ContractName>
            <SiteContractValidFrom>dateTime</SiteContractValidFrom>
            <SiteContractValidTo>dateTime</SiteContractValidTo>
            <ScheduleID>int</ScheduleID>
            <ScheduleName>string</ScheduleName>
            <PaymentMethodID>int</PaymentMethodID>
            <PaymentMethodName>string</PaymentMethodName>
            <SiteContractGUID>string</SiteContractGUID>
            <ContractReference>string</ContractReference>
            <ContractPONumber>string</ContractPONumber>
            <SiteContractNotes>string</SiteContractNotes>
            <SiteAddress>string</SiteAddress>
            <SelectedEndDate>dateTime</SelectedEndDate>
            <InvoiceToDate>dateTime</InvoiceToDate>
            <WorkflowInstanceID>int</WorkflowInstanceID>
            <InstanceGuid>guid</InstanceGuid>
            <WorkflowFileID>int</WorkflowFileID>
            <WorkflowFileName>string</WorkflowFileName>
            <InstanceCurrentState>string</InstanceCurrentState>
          </SiteContract>
        </SiteContracts>
      </GetSiteContractsResult>
    </GetSiteContractsResponse>
  </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>
    <GetSiteContracts xmlns="http://webservices.whitespacews.com/">
      <sitecontractInput>
        <IncludeCommercial>boolean</IncludeCommercial>
      </sitecontractInput>
    </GetSiteContracts>
  </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>
    <GetSiteContractsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteContractsResult>
        <SiteContracts>
          <SiteContract>
            <ExtensionData xsi:nil="true" />
            <SiteContractID>int</SiteContractID>
            <SiteID>int</SiteID>
            <AccountSiteID>int</AccountSiteID>
            <ContractID>int</ContractID>
            <ContractTypeID>int</ContractTypeID>
            <ContractTypeName>string</ContractTypeName>
            <ContractStatusCode>string</ContractStatusCode>
            <ContractStatusDescription>string</ContractStatusDescription>
            <ContractName>string</ContractName>
            <SiteContractValidFrom>dateTime</SiteContractValidFrom>
            <SiteContractValidTo>dateTime</SiteContractValidTo>
            <ScheduleID>int</ScheduleID>
            <ScheduleName>string</ScheduleName>
            <PaymentMethodID>int</PaymentMethodID>
            <PaymentMethodName>string</PaymentMethodName>
            <SiteContractGUID>string</SiteContractGUID>
            <ContractReference>string</ContractReference>
            <ContractPONumber>string</ContractPONumber>
            <SiteContractNotes>string</SiteContractNotes>
            <SiteAddress>string</SiteAddress>
            <SelectedEndDate>dateTime</SelectedEndDate>
            <InvoiceToDate>dateTime</InvoiceToDate>
            <WorkflowInstanceID>int</WorkflowInstanceID>
            <InstanceGuid>guid</InstanceGuid>
            <WorkflowFileID>int</WorkflowFileID>
            <WorkflowFileName>string</WorkflowFileName>
            <InstanceCurrentState>string</InstanceCurrentState>
          </SiteContract>
          <SiteContract>
            <ExtensionData xsi:nil="true" />
            <SiteContractID>int</SiteContractID>
            <SiteID>int</SiteID>
            <AccountSiteID>int</AccountSiteID>
            <ContractID>int</ContractID>
            <ContractTypeID>int</ContractTypeID>
            <ContractTypeName>string</ContractTypeName>
            <ContractStatusCode>string</ContractStatusCode>
            <ContractStatusDescription>string</ContractStatusDescription>
            <ContractName>string</ContractName>
            <SiteContractValidFrom>dateTime</SiteContractValidFrom>
            <SiteContractValidTo>dateTime</SiteContractValidTo>
            <ScheduleID>int</ScheduleID>
            <ScheduleName>string</ScheduleName>
            <PaymentMethodID>int</PaymentMethodID>
            <PaymentMethodName>string</PaymentMethodName>
            <SiteContractGUID>string</SiteContractGUID>
            <ContractReference>string</ContractReference>
            <ContractPONumber>string</ContractPONumber>
            <SiteContractNotes>string</SiteContractNotes>
            <SiteAddress>string</SiteAddress>
            <SelectedEndDate>dateTime</SelectedEndDate>
            <InvoiceToDate>dateTime</InvoiceToDate>
            <WorkflowInstanceID>int</WorkflowInstanceID>
            <InstanceGuid>guid</InstanceGuid>
            <WorkflowFileID>int</WorkflowFileID>
            <WorkflowFileName>string</WorkflowFileName>
            <InstanceCurrentState>string</InstanceCurrentState>
          </SiteContract>
        </SiteContracts>
      </GetSiteContractsResult>
    </GetSiteContractsResponse>
  </soap12:Body>
</soap12:Envelope>