• Article

ReportingService2006.FireEvent Method

Raises an event based on the supplied parameters.

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

Syntax

'Declaration
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices/FireEvent", RequestNamespace := "https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices",  _
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
Public Sub FireEvent ( _
    EventType As String, _
    EventData As String, _
    Site As String _
)
'Usage
Dim instance As ReportingService2006
Dim EventType As String
Dim EventData As String
Dim Site As String

instance.FireEvent(EventType, EventData, _
    Site)

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

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

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

public function FireEvent(
    EventType : String, 
    EventData : String, 
    Site : String
)

Parameters

  • EventData
    Type: System.String
    The data that is associated with the event.
  • Site
    Type: System.String
    The fully qualified URL for the SharePoint site.

Remarks

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

SOAP Headers

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Required Permissions

ManageWeb()

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. The FireEvent method only supports the TimedSubscription event type. When specifying the TimedSubscription event type, you must also specify the subscription ID in EventData, which is returned by CreateSubscription or CreateSubscription.

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

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)
    {
        ReportingService2006 rs = new ReportingService2006();
        rs.Url = "http://<Server Name>" +
            "/_vti_bin/ReportServer/ReportService2006.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 ReportingService2006()
        rs.Url = "http://<Server Name>" + _
            "/_vti_bin/ReportServer/ReportService2006.asmx"
        rs.Credentials = _
            System.Net.CredentialCache.DefaultCredentials

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

        ' Get the subscriptions
        Dim subs As Subscription() = _
            rs.ListAllSubscriptions(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