Create Shift Substitutions (Override)

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.

"recurrence": {
  "type": "occurrence"
  "datesApplicable": {
    "from": "2024-09-24",
    "to": "2024-09-30"
  }
},

Repeat

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

"recurrence": {
  "type": "repeat"
  "datesApplicable": {
    "from": "2024-09-24",
    "to": "2024-09-30"
  }
},

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.

"recurrence": {
  "type": "periodic"
  "datesApplicable": {
    "from": "2024-09-24",
    "to": "2024-09-30"
  }
},

Return type

shiftSubstitution Object

Parameters