Scheduling API

The Scheduling APIs support the management of employee work schedules. Schedules can be added, updated, deleted, or retrieved using the various methods below. Employee schedules include a start/end time, hours, workgroup, and other pay information.

Table of Contents

1. Methods
2. Data Structures
3. Data Types

Methods

Add

Type	Name	Description
WRITE	appendEmployeeSchedule2ByIDNum	Add a schedule for a specific employee

Delete

Type	Name	Description
DELETE	removeEmployeeScheduleByUniqueID	Removes a single schedule for an employee
DELETE	removeEmployeeSchedulesInRangeByIDNum	Removes schedules for an employee that fall within the desired date range

Retrieve

Type	Name	Description
READ	evalEmpTemplateEligByIDNum	Evaluate an employees scheduling eligibility
READ	extractEmployeeSchedules2ByIDNum	Returns an employee’s schedule data for a specified date range
READ	extractEmployeePeriodShiftSchedulesByIDNum	Retrieve an employee’s shift work schedules for a selected pay period
READ	extractEmployeeSchedules2ByIDNum	Returns an employee’s schedule data for a specified date range
READ	extractRangedSchedules2UsingHyperQuery	Retrieve schedules for employees from hyperquery
READ	getSchedulePatternsSimple	Retrieve schedules patterns from system
READ	getScheduleStylesSimple	Retrieve schedules styles from system

Data Structures

Name	Description
TAeSchedule	Employee work schedule
TAeSchedule2	Employee work schedule with unique identifier
TAeShiftSchedule	Shift schedule information

Enumerated Data Types

Name	Description
TSchTypeEnum	Schedule planning types

Back to Top