OCSeriesEventGenerator - Global

The OCSeriesEventGenerator API generates the repeating VEVENTS for a user's iCalendar.

OCSeriesEventGenerator - getMemberCalendar (String groupId, String rotaId, String userId, Object dateRangeObj, Object memberSchedules, String calendarLink)

Returns an array of the repeating on-call events.

Table 1. Parameters
Name Type Description
groupId String The group sys id.
rotaId String The rota sys id.
userId String The user sys id.
dateRangeObj Object Contains the from and to dates for the data set.
memberSchedules Object The user's schedule.
calendarLink String A link back to the on-call calendar in the instance.
Table 2. Returns
Type Description
Array Array of the repeating on-call events.

OCSeriesEventGenerator - getRosterICalEvents (GlideRecord rotaScheduleSpanGR, GlideRecord memberScheduleSpanGR, Array seriesStartTimes, Object excludeItems, String repeatUntil, String timeZone, String calendarLink)

Returns an array of VEVENTs that represent the on-call for the provided rotaScheduleSpanGR and the memberScheduleSpanGR.

Table 3. Parameters
Name Type Description
rotaScheduleSpanGR GlideRecord A cmn_schedule_span glide record for a rota.
memberScheduleSpanGR GlideRecord A cmn_schedule_span glide record for a rota member.
seriesStartTimes Array An array of the repeating rota span start times.
excludeItems Object The schedule items that need to be excluded.
repeatUntil String A formatted ScheduleDateTime string.
timeZone String Time zone for the on-call rota.
calendarLink String A link to the on-call calendar for this user.
Table 4. Returns
Type Description
Array An array of VEVENTs that represent the on-call for the provided rotaScheduleSpanGR and the memberScheduleSpanGR.

OCSeriesEventGenerator - getRosterMemberEvents (GlideRecord rotaMemberGR, Array seriesStartTimes, Object excludeItems, String repeatUntil, String calendarLink)

Returns an array of the repeating on-call VEVENTS.

Table 5. Parameters
Name Type Description
rotaMemberGR GlideRecord A cmn_rota_member record.
seriesStartTimes Array An array of the repeating rota span start times.
excludeItems Object The schedule items that need to be excluded.
repeatUntil String A formatted ScheduleDateTime string.
calendarLink String A link to the on-call calendar for this user.
Table 6. Returns
Type Description
Array An array of the repeating on-call VEVENTS