RecurringPattern Class

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

Namespace

FSL

Usage

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

Example

This example shows code for RecurringPattern and its properties.

1global class RecurringPattern {
2    global enum DaysOfWeek {Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday}
3    global enum FrequencyType {DAILY, WEEKLY, MONTHLY}
4    global Set<DaysOfWeek> DaysOfWeek { get; set; }
5    global FrequencyType FrequencyType { get; set; }
6    global Integer Frequency { get; set; }
7    global Integer NumberOfVisits { get; set; }
8}

Recurring Pattern Properties

RecurringPattern contains the following properties.

DaysOfWeek

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..

Signature

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

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

Property Value

Type: Set<enum>

Usage

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.

Frequency

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

Signature

global Integer Frequency { get; set; }

Property Value

Type: Integer

FrequencyType

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

Signature

global FrequencyType FrequencyType { get; set; }

Property Value

Type: Enum

NumberOfVisits

Total number of appointments to schedule.

Signature

global Integer NumberOfVisits { get; set; }

Property Value

Type: Integer