Alerts

Click here for a complete list of operations.

GetAlerts

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 /_vti_bin/alerts.asmx HTTP/1.1
Host: ormistonss.eq.edu.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schemas.microsoft.com/sharepoint/soap/2002/1/alerts/GetAlerts"

<?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>
    <GetAlerts xmlns="http://schemas.microsoft.com/sharepoint/soap/2002/1/alerts/" />
  </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>
    <GetAlertsResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/2002/1/alerts/">
      <GetAlertsResult>
        <CurrentUser>string</CurrentUser>
        <AlertServerName>string</AlertServerName>
        <AlertServerUrl>string</AlertServerUrl>
        <AlertServerType>string</AlertServerType>
        <AlertsManagementUrl>string</AlertsManagementUrl>
        <AlertWebTitle>string</AlertWebTitle>
        <NewAlertUrl>string</NewAlertUrl>
        <AlertWebId>string</AlertWebId>
        <Alerts>
          <Alert>
            <Id>string</Id>
            <Title>string</Title>
            <Active>boolean</Active>
            <EventType>string</EventType>
            <AlertForTitle>string</AlertForTitle>
            <AlertForUrl>string</AlertForUrl>
            <EditAlertUrl>string</EditAlertUrl>
            <DeliveryChannels xsi:nil="true" />
          </Alert>
          <Alert>
            <Id>string</Id>
            <Title>string</Title>
            <Active>boolean</Active>
            <EventType>string</EventType>
            <AlertForTitle>string</AlertForTitle>
            <AlertForUrl>string</AlertForUrl>
            <EditAlertUrl>string</EditAlertUrl>
            <DeliveryChannels xsi:nil="true" />
          </Alert>
        </Alerts>
      </GetAlertsResult>
    </GetAlertsResponse>
  </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 /_vti_bin/alerts.asmx HTTP/1.1
Host: ormistonss.eq.edu.au
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>
    <GetAlerts xmlns="http://schemas.microsoft.com/sharepoint/soap/2002/1/alerts/" />
  </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>
    <GetAlertsResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/2002/1/alerts/">
      <GetAlertsResult>
        <CurrentUser>string</CurrentUser>
        <AlertServerName>string</AlertServerName>
        <AlertServerUrl>string</AlertServerUrl>
        <AlertServerType>string</AlertServerType>
        <AlertsManagementUrl>string</AlertsManagementUrl>
        <AlertWebTitle>string</AlertWebTitle>
        <NewAlertUrl>string</NewAlertUrl>
        <AlertWebId>string</AlertWebId>
        <Alerts>
          <Alert>
            <Id>string</Id>
            <Title>string</Title>
            <Active>boolean</Active>
            <EventType>string</EventType>
            <AlertForTitle>string</AlertForTitle>
            <AlertForUrl>string</AlertForUrl>
            <EditAlertUrl>string</EditAlertUrl>
            <DeliveryChannels xsi:nil="true" />
          </Alert>
          <Alert>
            <Id>string</Id>
            <Title>string</Title>
            <Active>boolean</Active>
            <EventType>string</EventType>
            <AlertForTitle>string</AlertForTitle>
            <AlertForUrl>string</AlertForUrl>
            <EditAlertUrl>string</EditAlertUrl>
            <DeliveryChannels xsi:nil="true" />
          </Alert>
        </Alerts>
      </GetAlertsResult>
    </GetAlertsResponse>
  </soap12:Body>
</soap12:Envelope>