RecurringPattern Class

Represents a global sharing class that is a required parameter for RecurringAppointmentsManager to return a pattern of appointments that recur weekly.

FSL

RecurringPatternis a global sharing class that is a required parameter for RecurringAppointmentsManager. All properties must be complete to call the RecurringAppointmentsManager API.

This example shows code for RecurringPattern and its properties.

RecurringPattern contains the following properties.

The list of the days that can be used to book appointments, which can be derived from the visiting hours record associated with the service appointment..

global Set<DaysOfWeek> DaysOfWeek { get; set; }

global enum<FSL.RecurringPattern> DaysOfWeek {Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday}

Type: Set<enum>

You can set DaysofWeek manually. Alternately, you can derive the days the customer is available from the visiting hours record associated with the work order that is associated with the service appointment passed into the API.

Only one visit should be scheduled per day. For example, if you are scheduling a total of six visits and set DaysOfWeek to Monday and Wednesday, the API doesn’t provide a response with more than one visit scheduled for Monday and one visit scheduled for Wednesday.

The number of appointments to book inside the FrequencyType time frame provided.

global Integer Frequency { get; set; }

Type: Integer

The frequency of recurring appointments. Currently, only weekly frequency is supported.

global FrequencyType FrequencyType { get; set; }

Type: Enum

Total number of appointments to schedule.

global Integer NumberOfVisits { get; set; }

Type: Integer