Recurrences

Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Recurrences

Recurrences are embedded into
Schedules and Substitutions and define how something recurs over time.

There are three types of recurrences supported:

◊    Occurrence

◊    Repeat

◊    Periodic

Occurrence

Used for shiftSubstitution

Occurrence defines specific dates on which a configuration occurs.

Repeat

Used for staffSchedule

Repeat defines a period of time over which a configuration occurs. "To"
is optional and if omitted occurs infinitely.

Periodic

Used for staffSchedule

Periodic, similar to repeat, defines a period of time over which a configuration
occurs. However, periodic may occur "ever other" or "every n" times.