PowerSuiteWebService Web Service

PowerSuiteWebService

Click here for a complete list of operations.

GetSiteNotifications

Returns all notifications 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/GetSiteNotifications"

<?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>
    <GetSiteNotifications xmlns="http://webservices.whitespacews.com/">
      <siteservicenotificationInput />
    </GetSiteNotifications>
  </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>
    <GetSiteNotificationsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteNotificationsResult>
        <SiteServiceNotifications>
          <SiteServiceNotification>
            <ExtensionData xsi:nil="true" />
            <NotificationID>int</NotificationID>
            <NotificationIcon>string</NotificationIcon>
            <NotificationIconURL>string</NotificationIconURL>
            <NotificationName>string</NotificationName>
            <ServiceID>int</ServiceID>
            <ServiceName>string</ServiceName>
            <SiteAddress>string</SiteAddress>
            <SiteID>int</SiteID>
            <SiteServiceNotificationID>int</SiteServiceNotificationID>
            <SiteServiceNotificationNotes>string</SiteServiceNotificationNotes>
            <SiteServiceNotificationValidFrom>dateTime</SiteServiceNotificationValidFrom>
            <SiteServiceNotificationValidTo>dateTime</SiteServiceNotificationValidTo>
          </SiteServiceNotification>
          <SiteServiceNotification>
            <ExtensionData xsi:nil="true" />
            <NotificationID>int</NotificationID>
            <NotificationIcon>string</NotificationIcon>
            <NotificationIconURL>string</NotificationIconURL>
            <NotificationName>string</NotificationName>
            <ServiceID>int</ServiceID>
            <ServiceName>string</ServiceName>
            <SiteAddress>string</SiteAddress>
            <SiteID>int</SiteID>
            <SiteServiceNotificationID>int</SiteServiceNotificationID>
            <SiteServiceNotificationNotes>string</SiteServiceNotificationNotes>
            <SiteServiceNotificationValidFrom>dateTime</SiteServiceNotificationValidFrom>
            <SiteServiceNotificationValidTo>dateTime</SiteServiceNotificationValidTo>
          </SiteServiceNotification>
        </SiteServiceNotifications>
      </GetSiteNotificationsResult>
    </GetSiteNotificationsResponse>
  </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>
    <GetSiteNotifications xmlns="http://webservices.whitespacews.com/">
      <siteservicenotificationInput />
    </GetSiteNotifications>
  </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>
    <GetSiteNotificationsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteNotificationsResult>
        <SiteServiceNotifications>
          <SiteServiceNotification>
            <ExtensionData xsi:nil="true" />
            <NotificationID>int</NotificationID>
            <NotificationIcon>string</NotificationIcon>
            <NotificationIconURL>string</NotificationIconURL>
            <NotificationName>string</NotificationName>
            <ServiceID>int</ServiceID>
            <ServiceName>string</ServiceName>
            <SiteAddress>string</SiteAddress>
            <SiteID>int</SiteID>
            <SiteServiceNotificationID>int</SiteServiceNotificationID>
            <SiteServiceNotificationNotes>string</SiteServiceNotificationNotes>
            <SiteServiceNotificationValidFrom>dateTime</SiteServiceNotificationValidFrom>
            <SiteServiceNotificationValidTo>dateTime</SiteServiceNotificationValidTo>
          </SiteServiceNotification>
          <SiteServiceNotification>
            <ExtensionData xsi:nil="true" />
            <NotificationID>int</NotificationID>
            <NotificationIcon>string</NotificationIcon>
            <NotificationIconURL>string</NotificationIconURL>
            <NotificationName>string</NotificationName>
            <ServiceID>int</ServiceID>
            <ServiceName>string</ServiceName>
            <SiteAddress>string</SiteAddress>
            <SiteID>int</SiteID>
            <SiteServiceNotificationID>int</SiteServiceNotificationID>
            <SiteServiceNotificationNotes>string</SiteServiceNotificationNotes>
            <SiteServiceNotificationValidFrom>dateTime</SiteServiceNotificationValidFrom>
            <SiteServiceNotificationValidTo>dateTime</SiteServiceNotificationValidTo>
          </SiteServiceNotification>
        </SiteServiceNotifications>
      </GetSiteNotificationsResult>
    </GetSiteNotificationsResponse>
  </soap12:Body>
</soap12:Envelope>