AlertService Web Service

AlertService

Click here for a complete list of operations.

GetScenarioList

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

<?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>
    <GetScenarioList xmlns="http://service.desktopalert.net/AlertService.asmx">
      <AccountID>int</AccountID>
    </GetScenarioList>
  </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>
    <GetScenarioListResponse xmlns="http://service.desktopalert.net/AlertService.asmx">
      <GetScenarioListResult>
        <Scenario>
          <Id>int</Id>
          <AccountId>int</AccountId>
          <Name>string</Name>
          <Created>dateTime</Created>
          <AuthorUsername>string</AuthorUsername>
          <Title>string</Title>
          <Content>string</Content>
          <Hyperlink>string</Hyperlink>
          <Animation>SlideUp or FadeIn</Animation>
          <Width>int</Width>
          <Height>int</Height>
          <Keywords>string</Keywords>
          <ExcludedUsers>string</ExcludedUsers>
          <IncludedUsers>string</IncludedUsers>
          <DeviceOptions>int</DeviceOptions>
          <Groups>string</Groups>
          <LogoImageGuid>guid</LogoImageGuid>
        </Scenario>
        <Scenario>
          <Id>int</Id>
          <AccountId>int</AccountId>
          <Name>string</Name>
          <Created>dateTime</Created>
          <AuthorUsername>string</AuthorUsername>
          <Title>string</Title>
          <Content>string</Content>
          <Hyperlink>string</Hyperlink>
          <Animation>SlideUp or FadeIn</Animation>
          <Width>int</Width>
          <Height>int</Height>
          <Keywords>string</Keywords>
          <ExcludedUsers>string</ExcludedUsers>
          <IncludedUsers>string</IncludedUsers>
          <DeviceOptions>int</DeviceOptions>
          <Groups>string</Groups>
          <LogoImageGuid>guid</LogoImageGuid>
        </Scenario>
      </GetScenarioListResult>
    </GetScenarioListResponse>
  </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>
    <GetScenarioList xmlns="http://service.desktopalert.net/AlertService.asmx">
      <AccountID>int</AccountID>
    </GetScenarioList>
  </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>
    <GetScenarioListResponse xmlns="http://service.desktopalert.net/AlertService.asmx">
      <GetScenarioListResult>
        <Scenario>
          <Id>int</Id>
          <AccountId>int</AccountId>
          <Name>string</Name>
          <Created>dateTime</Created>
          <AuthorUsername>string</AuthorUsername>
          <Title>string</Title>
          <Content>string</Content>
          <Hyperlink>string</Hyperlink>
          <Animation>SlideUp or FadeIn</Animation>
          <Width>int</Width>
          <Height>int</Height>
          <Keywords>string</Keywords>
          <ExcludedUsers>string</ExcludedUsers>
          <IncludedUsers>string</IncludedUsers>
          <DeviceOptions>int</DeviceOptions>
          <Groups>string</Groups>
          <LogoImageGuid>guid</LogoImageGuid>
        </Scenario>
        <Scenario>
          <Id>int</Id>
          <AccountId>int</AccountId>
          <Name>string</Name>
          <Created>dateTime</Created>
          <AuthorUsername>string</AuthorUsername>
          <Title>string</Title>
          <Content>string</Content>
          <Hyperlink>string</Hyperlink>
          <Animation>SlideUp or FadeIn</Animation>
          <Width>int</Width>
          <Height>int</Height>
          <Keywords>string</Keywords>
          <ExcludedUsers>string</ExcludedUsers>
          <IncludedUsers>string</IncludedUsers>
          <DeviceOptions>int</DeviceOptions>
          <Groups>string</Groups>
          <LogoImageGuid>guid</LogoImageGuid>
        </Scenario>
      </GetScenarioListResult>
    </GetScenarioListResponse>
  </soap12:Body>
</soap12:Envelope>