ReportingService2010.FireEvent Method (String, String, String)

Applies To: SQL Server 2016 Preview

Raises an event based on the supplied parameters.

Namespace:   ReportService2010
Assembly:  ReportService2010 (in ReportService2010.dll)

Syntax

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/FireEvent", 
    RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
public void FireEvent(
    string EventType,
    string EventData,
    string SiteUrl
)

public:
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/FireEvent", 
    RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
void FireEvent(
    String^ EventType,
    String^ EventData,
    String^ SiteUrl
)

[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/FireEvent",
    RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
member FireEvent : 
        EventType:string *
        EventData:string *
        SiteUrl:string -> unit

<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/FireEvent",
    RequestNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)>
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)>
<SoapHeaderAttribute("TrustedUserHeaderValue")>
Public Sub FireEvent (
    EventType As String,
    EventData As String,
    SiteUrl As String
)

Parameters

• EventType
  Type: System.String

  The name of the event.

• EventData
  Type: System.String

  The data that is associated with the event.

• SiteUrl
  Type: System.String

  The fully qualified URL for the SharePoint site.

  Specify null (Nothing in Visual Basic) when invoking this method in Native mode.

Remarks

The table below shows header and permissions information on this operation.

This method throws an rsUnsupportedParameterForModeException exception if a non-null value is specified for the SiteUrl parameter in Native mode.

The EventType parameter is matched against the known set of events that are defined in the report server configuration file (rsreportserver.config). If the event is not in the report server configuration file, a SOAP exception is thrown with an error code of rsUnknownEventType. This method supports the TimedSubscription and RefreshCache event types.

If EventType is TimedSubscription, specify the subscription ID in EventData, which is returned by CreateSubscription or CreateDataDrivenSubscription or CreateDataDrivenSubscription. If EventType is RefreshCache, specify the cache refresh plan ID in EventData, which is returned by CreateCacheRefreshPlan.

The FireEvent method does not verify or validate the data supplied in the EventData parameter. Any string value is valid including an empty string.

Examples

Legacy Code Example

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;

class Sample
{
    static void Main(string[] args)
    {
        ReportingService2010 rs = new ReportingService2010();
        rs.Url = "http://<Server Name>" +
            "/_vti_bin/ReportServer/ReportService2010.asmx";
        rs.Credentials = 
            System.Net.CredentialCache.DefaultCredentials;

        string site = "http://<Server Name>";

        // Get the subscriptions
        Subscription[] subs = 
            rs.ListMySubscriptions(site);

        try
        {
            if (subs != null)
            {
                // Fire the first subscription in the list
                rs.FireEvent("TimedSubscription", 
                    subs[0].SubscriptionID, site);
                Console.WriteLine("Event fired.");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}

Imports System
Imports System.IO
Imports System.Text
Imports System.Web.Services
Imports System.Web.Services.Protocols

Class Sample

    Public Shared Sub Main()

        Dim rs As New ReportingService2010()
        rs.Url = "http://<Server Name>" + _
            "/_vti_bin/ReportServer/ReportService2010.asmx"
        rs.Credentials = _
            System.Net.CredentialCache.DefaultCredentials

        Dim site As String = "http://<Server Name>"

        ' Get the subscriptions
        Dim subs As Subscription() = _
            rs.ListSubscriptions(site)

        Try
            If Not (subs Is Nothing) Then
                ' Fire the first subscription in the list
                rs.FireEvent("TimedSubscription", subs(0).SubscriptionID, site)
                Console.WriteLine("Event fired.")
            End If
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try

    End Sub

End Class

See Also

ReportingService2010 Class
ReportService2010 Namespace

Return to top