ReportingService2010.GetScheduleProperties Method

Returns the properties of a shared schedule.

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

Syntax

'Declaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetScheduleProperties", 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)> _
Public Function GetScheduleProperties ( _
    ScheduleID As String _
) As Schedule
'Usage
Dim instance As ReportingService2010 
Dim ScheduleID As String 
Dim returnValue As Schedule 

returnValue = instance.GetScheduleProperties(ScheduleID)

[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetScheduleProperties", 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)]
public Schedule GetScheduleProperties(
    string ScheduleID
)

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

[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetScheduleProperties", 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)>]
member GetScheduleProperties : 
        ScheduleID:string -> Schedule

public function GetScheduleProperties(
    ScheduleID : String
) : Schedule

Parameters

• ScheduleID
  Type: System.String
  The ID of the schedule.

Return Value

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

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	Open

The MonthlyDOWRecurrence pattern is not supported in SharePoint integrated mode.

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

See Also

Reference

ReportingService2010 Class

ReportService2010 Namespace