This resource allows managers to retrieve employee visibility periods and filter by ID, name, or search criteria.
An employee visibility period defines the:
- Submission Period -- The time period when an employee can submit a request for schedule changes.
- Request Period -- The date range when the request can occur. Example: If the request period is July 1-August 31, the employee can submit requests only for times during July and August.
- Group Type -- The Hyperfind query of employees who can submit requests.
- Recurring Period -- Repeats the schedule every X days, weeks, or months.
- Rolling Period -- Moves the entire schedule forward by a day at a time. The employee can request a schedule change after x number of days from that day (to give lead time to the manager) for a specific time period or for an unlimited time. For example, if the date today is May 15th, the employee can request time off, after a 5 day delay, on May 20th for 30 days.
- Schedule and Open Shift Visibility -- Employees can see the unposted schedule during the submission period and available open shifts.
Operations
Retrieve All Employee Visibility Periods or by Name
GET /v1/scheduling/setup/employee_visibility_periods
Retrieve Eligible Submission Periods
POST /v1/scheduling/setup/employee_visibility_periods/apply_read
Retrieve Employee Visibility Period by ID
GET /v1/scheduling/setup/employee_visibility_periods/{id}
Retrieve Employee Visibility Periods
POST /v1/scheduling/setup/employee_visibility_periods/multi_read