ReportingService2010.GetSubscriptionProperties Method
SQL Server 2008 R2
Returns the properties of a specified subscription.
Assembly: ReportService2010 (in ReportService2010.dll)
'Declaration <SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetSubscriptionProperties", RequestNamespace := "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", _ ResponseNamespace := "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", _ Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _ <SoapHeaderAttribute("TrustedUserHeaderValue")> _ <SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _ Public Function GetSubscriptionProperties ( _ SubscriptionID As String, _ <OutAttribute> ByRef ExtensionSettings As ExtensionSettings, _ <OutAttribute> ByRef Description As String, _ <OutAttribute> ByRef Active As ActiveState, _ <OutAttribute> ByRef Status As String, _ <OutAttribute> ByRef EventType As String, _ <OutAttribute> ByRef MatchData As String, _ <OutAttribute> ByRef Parameters As ParameterValue() _ ) As String 'Usage Dim instance As ReportingService2010 Dim SubscriptionID As String Dim ExtensionSettings As ExtensionSettings Dim Description As String Dim Active As ActiveState Dim Status As String Dim EventType As String Dim MatchData As String Dim Parameters As ParameterValue() Dim returnValue As String returnValue = instance.GetSubscriptionProperties(SubscriptionID, _ ExtensionSettings, Description, _ Active, Status, EventType, MatchData, _ Parameters)
Parameters
- SubscriptionID
- Type: System.String
The ID of the subscription.
- ExtensionSettings
- Type: ReportService2010.ExtensionSettings%
[out] An ExtensionSettings object that contains a list of settings that are specific to the delivery extension.
- Description
- Type: System.String%
[out] A meaningful description that is displayed to users.
- Active
- Type: ReportService2010.ActiveState%
[out] An ActiveState object that contains the active state of the subscription.
- Status
- Type: System.String%
[out] The status of the subscription.
- EventType
- Type: System.String%
[out] The type of event that triggers the subscription.
- MatchData
- Type: System.String%
[out] The data that is associated with the specified type of event. This is used by an event processing extension to match the subscription with an event that has occurred.
- Parameters
- Type: ReportService2010.ParameterValue()%
[out] An array of ParameterValue objects that contains a list of parameters for the report.
The table below shows header and permissions information on this operation.
SOAP Header Usage | (Out) ServerInfoHeaderValue |
Native Mode Required Permissions | (ReadSubscription on the report AND the user is the subscription owner) OR ReadAnySubscription |
SharePoint Mode Required Permissions | ManageAlerts OR (CreateAlerts AND the user is the subscription owner) |
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 extSettings As ExtensionSettings Dim desc As String Dim active As ActiveState Dim status As String Dim eventType As String Dim matchData As String Dim values As ParameterValue() = Nothing Dim subscriptions As Subscription() = Nothing Dim extensionParams As ParameterValueOrFieldReference() = Nothing Try Dim site As String = "http://<Server Name>" subscriptions = rs.ListSubscriptions(site) If Not (subscriptions Is Nothing) Then rs.GetSubscriptionProperties( _ subscriptions(0).SubscriptionID, extSettings, _ desc, active, status, eventType, matchData, _ values) Console.WriteLine("Description: {0}", desc) Console.WriteLine("Status: {0}", status) Console.WriteLine("EventType: {0}", eventType) Console.WriteLine("matchData: {0}", matchData) Console.WriteLine("Extension: {0}", _ extSettings.Extension) extensionParams = extSettings.ParameterValues If Not (extensionParams Is Nothing) Then Dim extensionParam As _ ParameterValueOrFieldReference For Each extensionParam In extensionParams Console.WriteLine((CType(extensionParam, _ ParameterValue).Name + ": " + _ CType(extensionParam, ParameterValue).Value)) Next extensionParam End If If Not (values Is Nothing) Then Dim pv As ParameterValue For Each pv In values Console.WriteLine("Name: {0}", pv.Name) Console.WriteLine("Value: {0}", pv.Value) Next pv End If End If Catch e As SoapException Console.WriteLine(e.Detail.InnerXml.ToString()) End Try End Sub End Class
