ReportingService2010.GetScheduleProperties(String) Method

Reference

Definition

Namespace:: ReportService2010

Assembly:: ReportService2010.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the properties of a shared schedule.

public:
 ReportService2010::Schedule ^ GetScheduleProperties(System::String ^ ScheduleID);

[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetScheduleProperties", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)]
[System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")]
[System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)]
public ReportService2010.Schedule GetScheduleProperties (string ScheduleID);

[<System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetScheduleProperties", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)>]
[<System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")>]
[<System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)>]
member this.GetScheduleProperties : string -> ReportService2010.Schedule

Public Function GetScheduleProperties (ScheduleID As String) As Schedule

Parameters

ScheduleID: String

The ID of the schedule.

Returns

Schedule

A Schedule object that contains state information and the schedule definition for a single schedule.

Attributes: SoapDocumentMethodAttribute SoapHeaderAttribute

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

        ScheduleDefinition definition = new ScheduleDefinition();  
        string scheduleID;  
        // Create the schedule definition.  
        definition.StartDateTime =   
            new DateTime(2003, 3, 1, 14, 0, 0);  
        WeeklyRecurrence recurrence = new WeeklyRecurrence();  
        DaysOfWeekSelector days = new DaysOfWeekSelector();  
        days.Monday = true;  
        days.Tuesday = true;  
        days.Wednesday = true;  
        days.Thursday = true;  
        days.Friday = true;  
        days.Saturday = false;  
        days.Sunday = false;  
        recurrence.DaysOfWeek = days;  
        recurrence.WeeksInterval = 1;  
        recurrence.WeeksIntervalSpecified = true;  
        definition.Item = recurrence;  

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

            scheduleID = rs.CreateSchedule("My Schedule",   
                definition, site);  
            Console.WriteLine("Schedule created with ID {0}",   
                scheduleID);  

            rs.GetScheduleProperties(scheduleID);  

            recurrence = (WeeklyRecurrence)definition.Item;  
            Console.WriteLine(definition.StartDateTime);  
            Console.WriteLine(definition.EndDate);  

            days = recurrence.DaysOfWeek;  
            Console.WriteLine("Monday: {0}", days.Monday);  
            Console.WriteLine("Tuesday: {0}", days.Tuesday);  
            Console.WriteLine("Wednesday: {0}", days.Wednesday);  
            Console.WriteLine("Thursday: {0}", days.Thursday);  
            Console.WriteLine("Friday: {0}", days.Friday);  
            Console.WriteLine("Saturday: {0}", days.Saturday);  
            Console.WriteLine("Sunday: {0}", days.Sunday);  
            Console.WriteLine("Weeks Interval: {0}",   
                recurrence.WeeksInterval);  
        }  
        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 definition As New ScheduleDefinition()  
        Dim scheduleID As String  
        ' Create the schedule definition.  
        definition.StartDateTime = New DateTime(2003, 3, 1, 14, 0, 0)  
        Dim recurrence As New WeeklyRecurrence()  
        Dim days As New DaysOfWeekSelector()  
        days.Monday = True  
        days.Tuesday = True  
        days.Wednesday = True  
        days.Thursday = True  
        days.Friday = True  
        days.Saturday = False  
        days.Sunday = False  
        recurrence.DaysOfWeek = days  
        recurrence.WeeksInterval = 1  
        recurrence.WeeksIntervalSpecified = True  
        definition.Item = recurrence  

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

            scheduleID = rs.CreateSchedule("My Schedule", _  
                definition, site)  
            Console.WriteLine("Schedule created with ID {0}", _  
                scheduleID)  

            rs.GetScheduleProperties(scheduleID)  

            recurrence = CType(definition.Item, WeeklyRecurrence)  
            Console.WriteLine(definition.StartDateTime)  
            Console.WriteLine(definition.EndDate)  

            days = recurrence.DaysOfWeek  
            Console.WriteLine("Monday: {0}", days.Monday)  
            Console.WriteLine("Tuesday: {0}", days.Tuesday)  
            Console.WriteLine("Wednesday: {0}", days.Wednesday)  
            Console.WriteLine("Thursday: {0}", days.Thursday)  
            Console.WriteLine("Friday: {0}", days.Friday)  
            Console.WriteLine("Saturday: {0}", days.Saturday)  
            Console.WriteLine("Sunday: {0}", days.Sunday)  
            Console.WriteLine("Weeks Interval: {0}", _  
                recurrence.WeeksInterval)  

        Catch e As SoapException  
            Console.WriteLine(e.Detail.InnerXml.ToString())  
        End Try  

    End Sub  

End Class

Remarks

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


SOAP Header Usage	(In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue
Native Mode Required Permissions	ReadSchedules (System)
SharePoint Mode Required Permissions	<xref:Microsoft.SharePoint.SPBasePermissions.Open>

The MonthlyDOWRecurrence pattern is not supported in SharePoint integrated mode.

Applies to

Share via