ReportingService2010.GetSubscriptionProperties Method (String, ExtensionSettings, String, ActiveState, String, String, String, ParameterValue )

Article
07/27/2015

Applies To: SQL Server 2016 Preview

Returns the properties of a specified subscription.

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

Syntax

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetSubscriptionProperties", 
    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("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public string GetSubscriptionProperties(
    string SubscriptionID,
    out ExtensionSettings ExtensionSettings,
    out string Description,
    out ActiveState Active,
    out string Status,
    out string EventType,
    out string MatchData,
    out ParameterValue[] Parameters
)

public:
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetSubscriptionProperties", 
    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("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
String^ GetSubscriptionProperties(
    String^ SubscriptionID,
    [OutAttribute] ExtensionSettings^% ExtensionSettings,
    [OutAttribute] String^% Description,
    [OutAttribute] ActiveState^% Active,
    [OutAttribute] String^% Status,
    [OutAttribute] String^% EventType,
    [OutAttribute] String^% MatchData,
    [OutAttribute] array<ParameterValue^>^% Parameters
)

[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetSubscriptionProperties",
    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("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member GetSubscriptionProperties : 
        SubscriptionID:string *
        ExtensionSettings:ExtensionSettings byref *
        Description:string byref *
        Active:ActiveState byref *
        Status:string byref *
        EventType:string byref *
        MatchData:string byref *
        Parameters:ParameterValue[] byref -> string

<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetSubscriptionProperties",
    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("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

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.

Return Value

Type: System.String

The user ID for the owner of the subscription.

Remarks

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

SOAP Header Usage

(In) TrustedUserHeaderValue

(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)

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;

        ExtensionSettings extSettings;
        string desc;
        ActiveState active;
        string status;
        string eventType;
        string matchData;
        ParameterValue[] values = null;
        Subscription[] subscriptions = null;
        ParameterValueOrFieldReference[] extensionParams = null;

        try
        {
            subscriptions = 
                rs.ListSubscriptions("http://<Server Name>");

            if (subscriptions != null)
            {
                rs.GetSubscriptionProperties(
                    subscriptions[0].SubscriptionID, out extSettings,
                    out desc, out active, out status, out eventType, 
                   out matchData, out 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 (extensionParams != null)
                {
                    foreach (ParameterValueOrFieldReference 
                        extensionParam in extensionParams)
                    {
                        Console.WriteLine(
                            ((ParameterValue)extensionParam).Name
                            + ": " + ((ParameterValue)
                            extensionParam).Value);
                    }
                }

                if (values != null)
                {
                    foreach (ParameterValue pv in values)
                    {
                        Console.WriteLine("Name: {0}", pv.Name);
                        Console.WriteLine("Value: {0}", pv.Value);
                    }
                }
            }
        }
        catch (SoapException e)
        {
            Console.WriteLine(e.Detail.InnerXml.ToString());
        }
    }
}

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