Create Staff Schedule

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"
  }
},

• When listing all staff schedule the query parameter filter[fieldName] supports filtering response with the following fields,

  • id
  • accountId
  • calendarId
  • createdId
  • createdName
  • escalationOption
  • lastModifiedName
  • minStaff
  • name
  • organizationId
  • recurrence.type
  • recurrence.datesApplicable.from
  • recurrence.datesApplicable.to
  • recurrence.everyNRecurrence
  • onCallReminder.enabled
  • resourceBundleId
  • seq
  • sequencingOverrideAllowed
  • shiftScheduleId
  • staffAssignments.type
  • staffEachDay
  • status

  Example Usage: filter[calendarId]

• While creating non-periodic staff schedule or staff schedule for all days of the week set the data.recurrence.repeat to repeat

Staff Assignments

Staff Assignments are embedded into StaffSchedule, ShiftSubstitution, and staffSubstitution to define who is staffed.

Contact

Staff specifies a set of contact IDs.

{
  "type": "contact",
  "days": [2, 3, 4, 5, 6],
  "contactIds": [1111, 22222, 33333]
}

Group

Staff specifies a set of groupIDs.

{
  "type": "group",
  "days": [3],
  "groupIds": [33, 333, 33333]
}

Mixed

Mixed permits a combination of group and staff. It could be used to specify contactIDs or groupIDs only.

{
  "type": "mixed",
  "ids": [
    {
      "id": 44,
      "type": "contact"
    },
    {
      "id": 4444,
      "type": "group"
    }
  ],
  "days": [4]
}

iCal

Used for substitions or staffSchedule rotation. Defines a recurrence based upon the iCal standard.

See RFC 2445 and the recurrence rule below,

{
  "recurrence": {
    "type": "ical",
    "rule": "FREQ=WEEKLY;WKST=MO;BYDAY=MO,TU,TH",
    "datesApplicable": {
      "from": "2017-02-01"
    }
  }
}

Fields

4.3.10 Recurrence Rule

Staff Rotation

Request Body