ReportingService2010.CreateSchedule Method

Definition

Namespace:

ReportService2010

Assembly:

ReportService2010.dll

Creates a new shared schedule.

public:
 System::String ^ CreateSchedule(System::String ^ Name, ReportService2010::ScheduleDefinition ^ ScheduleDefinition, System::String ^ SiteUrl);

[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSchedule", 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 string CreateSchedule (string Name, ReportService2010.ScheduleDefinition ScheduleDefinition, string SiteUrl);

[<System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSchedule", 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.CreateSchedule : string * ReportService2010.ScheduleDefinition * string -> string

Public Function CreateSchedule (Name As String, ScheduleDefinition As ScheduleDefinition, SiteUrl As String) As String

Parameters

Name

String

The name of the schedule.

ScheduleDefinition

ScheduleDefinition

A ScheduleDefinition object that defines the properties and values for the schedule.

SiteUrl

String

The fully qualified URL for the SharePoint site.

Set this parameter to null (Nothing in Visual Basic) when invoking this method in Native mode.

Returns

String

A String value that represents the ID of the newly created 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);  
        }  
        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()a  
        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)  

        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	CreateSchedules (System)
SharePoint Mode Required Permissions	<xref:Microsoft.SharePoint.SPBasePermissions.ManageWeb>

This method throws an rsUnsupportedParameterForModeException exception if a non-null value is specified for the SiteUrl parameter in Native mode.

If an error occurs when the CreateSchedule method runs, the schedule is not created and no schedule ID is returned.

The MonthlyDOWRecurrence pattern is not supported in SharePoint integrated mode.