Get Shift Segment APIs
These APIs return shift segment information for specified start and end times. Holidays are excluded from working hours during calculation. Returns a ShiftSegmentItem record.
Get Shift Segment That Contains Specified Target Date Based on Logged-in User
getFallInShiftSegment(DateTime targetDate, Boolean filterPassed = true)
The effective shift is based on the logged-in user. To filter out durations before start times or after end times, set filterPassed to true.
Get Shift Segment That Contains Specified Target Date Based on Passed-in User
getFallInShiftSegmentByUser(UUID userId, DateTime targetDate, Boolean filterPassed = true)
The effective shift is based on the passed-in user. If no User Preference setting is found, system settings are used.
Get Shift Segment That Contains Specified Target Date Based on Passed-in Shift
getFallInShiftSegmentByShift(UUID shiftId, DateTime targetDate, Boolean filterPassed = true)
The effective shift is based on the passed-in shift.
Get Shift Segment That Contains Specified Start and End Times Based on Logged-in User
getFallInShiftSegmentForDuration(DateTime startTime, DateTime endTime)
The effective shift is based on the logged in-user.
Get Shift Segment That Contains Specified Start and End Times Based on Passed-in User
getFallInShiftSegmentForDurationByUser(UUID userId, DateTime startTime, DateTime endTime)
The effective shift is based on the passed-in user.
Get Shift Segment That Contains Specified Start and End Times Based on Passed-in Shift
getFallInShiftSegmentForDurationByShift (UUID shiftId, DateTime startTime, DateTime endTime)
The effective shift is based on the passed-in shift.
For more information: