ReportingService2010.CreateSchedule Method

Creates a new shared schedule.

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

Syntax

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

returnValue = instance.CreateSchedule(Name, _
    ScheduleDefinition, SiteUrl)
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSchedule", 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("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public string CreateSchedule(
    string Name,
    ScheduleDefinition ScheduleDefinition,
    string SiteUrl
)
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute(L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSchedule", RequestNamespace = L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
String^ CreateSchedule(
    String^ Name, 
    ScheduleDefinition^ ScheduleDefinition, 
    String^ SiteUrl
)
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSchedule", 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("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member CreateSchedule : 
        Name:string * 
        ScheduleDefinition:ScheduleDefinition * 
        SiteUrl:string -> string 
public function CreateSchedule(
    Name : String, 
    ScheduleDefinition : ScheduleDefinition, 
    SiteUrl : String
) : String

Parameters

  • SiteUrl
    Type: System.String
    The fully qualified URL for the SharePoint site.
    Set this parameter to nulla null reference (Nothing in Visual Basic) (Nothing in Visual Basic) when invoking this method in Native mode.

Return Value

Type: System.String
A String value that represents the ID of the newly created schedule.

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

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.

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