Employee API

The Employee APIs support the management of employees in an organization. An employee is a person who performs duties and responsibilities for an organization. Employees and related information can be added, updated, deleted, or retrieved using the various methods below. Employee functions can also be integrated using the API.

Table of Contents

1. Methods
2. Data Structures
3. Data Types

Methods

Lists/Totals

Type	Name	Description
READ	getActiveEmployeesCount	Retrieve current count of active employees
READ	getActiveEmployeesList	Retrieve current list of active employees
READ	getAllEmployeesList	Retrieve current list of all employees
READ	getInactiveEmployeesCount	Retrieve current count of inactive employees
READ	getInactiveEmployeesList	Retrieve current list of inactive employees
READ	getTotalEmployeeCount	Retrieve current count of all employees

Employee Self Service

Type	Name	Description
READ	extractEmployeeSelfServiceOperationsByIDNum	Retrieve ESS operations available for employee
READ	getEmpESSPreAuthLoginURL	Retrieve a URL to use in an ESS IFRAME single sign on session
READ	getEmployeeESSEMailByIDNum	Retrieve email address for employee
READ	getEmployeeESSPINByIDNum	Retrieve ESS pin for employee

Information - Delete

Type	Name	Description
DELETE	flushEmployeeActivityLog	Delete activity log for employee
DELETE	removeEmpAttribsAssignByUniqueID	Delete employee attribute assignment record
DELETE	removeEmpCertAssignByUniqueID	Delete employee certification assignment record
DELETE	removeEmployeeRateHistoryByIDNum	Delete pay rate history for employee
DELETE	removeEmployeeRateHistoryEntry	Delete a pay rate entry for employee
DELETE	removeEmployeeTransferRate	Delete a transfer rate for employee

Information - Retrieve

Type	Name	Description
READ	extractAttributes	Retrieve a list of Attributes
READ	extractCertifications	Retrieve a list of Certifications
READ	extractEmpAttribsAssignsByIDnum	Retrieve an employees assigned attributes
READ	extractEmpCertAssignsByIDnum	Retrieve an employees assigned certifications
READ	extractEmployeeRatePayTypeAssignmentByIDNum	Retrieve employee pay type
READ	extractEmployeeWorkgroupAssignmentByIDNum	Retrieve workgroup assignments for employee
READ	getEmployeeActivityLog	Retrieve activity log for employee
READ	getEmployeeDetail2ByIDNum	Retrieve all information for employee
READ	getEmployeeESSEMailByIDNum	Retrieve email address for employee
READ	getEmployeeESSPINByIDNum	Retrieve ESS pin for employee
READ	getEmployeeRateHistoryByIDNum	Retrieve pay rate history for employee
READ	getEmployeesListDetail2FromHyperQuery	Retrieve information on group of employees from hyperquery
READ	getEmployeesListDetail2FromHyperQueryWorkgroupFilter	Retrieve information on group of employees from hyperquery and workgroup
READ	getEmployeesSearchListDetail2	Retrieve list of employees by wildcard search
READ	getEmployeeTransferRate	Retrieve a transfer rate for employee
READ	getEmployeeTransferRatesByIDNum	Retrieve all transfer rates for employee
READ	getEmployeeTZObservesDSTByIDNum	Retrieve yes/no value if employee resides in time zone with DST
READ	getEmployeeTZOffsetByIDNum	Retrieve offset value for employee from corporate time zone
READ	getEmptyEmpAttribsAssign	Retrieve empty TAeEmpAttribsAssign structure
READ	getEmptyEmpCertAssign	Retrieve empty TAeEmpCertAssign structure
READ	getEmptyEmployeeDetail2	Retrieve an empty TAeEmployeeDetail2 structure
READ	getEmptyRatePayTypeAssignment	Retrieve an empty TAeRatePayTypeAssignment structure

Information - Update

Type	Name	Description
WRITE	addEmployeeTransferRate	Add a transfer rate to employee record
WRITE	appendEmpAttribsAssignByIDnum	Add an employee attribute
WRITE	appendEmpCertAssignByIDnum	Add an employee certification
WRITE	appendEmployeeTransferByIDNum	Add a transfer rate to employee record
WRITE	maintainEmployeeDetail2	Add or update employee information
WRITE	maintainEmployeeResultDescr	Retrieve a description for the result of maintainEmployeeDetail2 call
WRITE	reassignEmployeeRatePayType	Update rate and pay type for employee
WRITE	reassignEmployeeWorkgroup	Update workgroup for employee
WRITE	setManuallySelectedEmployeeData	Enter time card edits in bulk or other commands
WRITE	transferEmployeeNowByIDNum	Add a workgroup transfer for the employee
WRITE	updateEmployeeTransferRate	Add or update a transfer rate for employee

Data Structures

Name	Description
TAeAttribute	Employee Attribute
TAeCertification	Certifications
TAeEmpActLog	Logged employee activity
TAeEmpAttribsAssign	Employee attributes
TAeEmpCertAssign	Employee certifications
TAeEmployeeBasic	Basic level employee demographics
TAeEmployeeDetail	Detail level employee demographics - inherits TAeEmployeeBasic
TAeEmployeeDetail2	Detail2 level employee demographics - inherits TAeEmployeeDetai
TAeEmployeeSelfServiceOperation	Employee self service usage detail
TAeEmpTranRate	Employee transfer rate history
TAeESSPreAuthPackage	Operator identification package
TAeRateAssignment	Employee pay rate information
TAeRatePayTypeAssignment	Employee pay rate and pay type information
TAeWorkgroupAssignment	Workgroup assignment for employee by date

Enumerated Data Types

Name	Description
TActiveStatusEnum	Employees current status
TAddEmpMode	Add or Update Employee data
TBadgeManagement	Badge Management Options
TCertDateFormEnum	Certification Date
TESSOperationEnum	ESS Operation Types
TMaintainEmployeeResult	Results of Adding/Updating Employee

Back to Top