AlertService

Click here for a complete list of operations.

GetUnreadAlerts

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 /alertservice.asmx HTTP/1.1
Host: www.fspscorpalerts.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://service.desktopalert.net/AlertService.asmx/GetUnreadAlerts"

<?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>
    <GetUnreadAlerts xmlns="http://service.desktopalert.net/AlertService.asmx" />
  </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>
    <GetUnreadAlertsResponse xmlns="http://service.desktopalert.net/AlertService.asmx">
      <GetUnreadAlertsResult>
        <SplashImageUrl>string</SplashImageUrl>
        <TrayIconUrl>string</TrayIconUrl>
        <PollInterval>int</PollInterval>
        <Version>string</Version>
        <UpdateUrl>string</UpdateUrl>
        <AlertServiceUrl>string</AlertServiceUrl>
        <Alerts>
          <Alert>
            <Guid>guid</Guid>
            <Created>dateTime</Created>
            <Published>dateTime</Published>
            <AuthorUsername>string</AuthorUsername>
            <Type>Text or Web or Shaped</Type>
            <Title>string</Title>
            <Content>string</Content>
            <Hyperlink>string</Hyperlink>
            <Animation>SlideUp or FadeIn</Animation>
            <Width>int</Width>
            <Height>int</Height>
            <LogoImageGuid>guid</LogoImageGuid>
            <Expiration>dateTime</Expiration>
            <IsRecurring>boolean</IsRecurring>
            <Expires>boolean</Expires>
            <RecurringInterval>int</RecurringInterval>
            <RecurringPeriod>string</RecurringPeriod>
            <SelfClose>int</SelfClose>
            <DelayXbutton>int</DelayXbutton>
            <OnlineCount>int</OnlineCount>
            <AvgReadTime xsi:nil="true" />
            <DeviceOptions>int</DeviceOptions>
          </Alert>
          <Alert>
            <Guid>guid</Guid>
            <Created>dateTime</Created>
            <Published>dateTime</Published>
            <AuthorUsername>string</AuthorUsername>
            <Type>Text or Web or Shaped</Type>
            <Title>string</Title>
            <Content>string</Content>
            <Hyperlink>string</Hyperlink>
            <Animation>SlideUp or FadeIn</Animation>
            <Width>int</Width>
            <Height>int</Height>
            <LogoImageGuid>guid</LogoImageGuid>
            <Expiration>dateTime</Expiration>
            <IsRecurring>boolean</IsRecurring>
            <Expires>boolean</Expires>
            <RecurringInterval>int</RecurringInterval>
            <RecurringPeriod>string</RecurringPeriod>
            <SelfClose>int</SelfClose>
            <DelayXbutton>int</DelayXbutton>
            <OnlineCount>int</OnlineCount>
            <AvgReadTime xsi:nil="true" />
            <DeviceOptions>int</DeviceOptions>
          </Alert>
        </Alerts>
      </GetUnreadAlertsResult>
    </GetUnreadAlertsResponse>
  </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 /alertservice.asmx HTTP/1.1
Host: www.fspscorpalerts.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>
    <GetUnreadAlerts xmlns="http://service.desktopalert.net/AlertService.asmx" />
  </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>
    <GetUnreadAlertsResponse xmlns="http://service.desktopalert.net/AlertService.asmx">
      <GetUnreadAlertsResult>
        <SplashImageUrl>string</SplashImageUrl>
        <TrayIconUrl>string</TrayIconUrl>
        <PollInterval>int</PollInterval>
        <Version>string</Version>
        <UpdateUrl>string</UpdateUrl>
        <AlertServiceUrl>string</AlertServiceUrl>
        <Alerts>
          <Alert>
            <Guid>guid</Guid>
            <Created>dateTime</Created>
            <Published>dateTime</Published>
            <AuthorUsername>string</AuthorUsername>
            <Type>Text or Web or Shaped</Type>
            <Title>string</Title>
            <Content>string</Content>
            <Hyperlink>string</Hyperlink>
            <Animation>SlideUp or FadeIn</Animation>
            <Width>int</Width>
            <Height>int</Height>
            <LogoImageGuid>guid</LogoImageGuid>
            <Expiration>dateTime</Expiration>
            <IsRecurring>boolean</IsRecurring>
            <Expires>boolean</Expires>
            <RecurringInterval>int</RecurringInterval>
            <RecurringPeriod>string</RecurringPeriod>
            <SelfClose>int</SelfClose>
            <DelayXbutton>int</DelayXbutton>
            <OnlineCount>int</OnlineCount>
            <AvgReadTime xsi:nil="true" />
            <DeviceOptions>int</DeviceOptions>
          </Alert>
          <Alert>
            <Guid>guid</Guid>
            <Created>dateTime</Created>
            <Published>dateTime</Published>
            <AuthorUsername>string</AuthorUsername>
            <Type>Text or Web or Shaped</Type>
            <Title>string</Title>
            <Content>string</Content>
            <Hyperlink>string</Hyperlink>
            <Animation>SlideUp or FadeIn</Animation>
            <Width>int</Width>
            <Height>int</Height>
            <LogoImageGuid>guid</LogoImageGuid>
            <Expiration>dateTime</Expiration>
            <IsRecurring>boolean</IsRecurring>
            <Expires>boolean</Expires>
            <RecurringInterval>int</RecurringInterval>
            <RecurringPeriod>string</RecurringPeriod>
            <SelfClose>int</SelfClose>
            <DelayXbutton>int</DelayXbutton>
            <OnlineCount>int</OnlineCount>
            <AvgReadTime xsi:nil="true" />
            <DeviceOptions>int</DeviceOptions>
          </Alert>
        </Alerts>
      </GetUnreadAlertsResult>
    </GetUnreadAlertsResponse>
  </soap12:Body>
</soap12:Envelope>