Get Employees
post
/config/sim/v2/employees/getEmployees
Gets all the Employees
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Employees.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Employee objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : Employeev2
Type:
Show Source
object-
alternateId:
integer
ID to use instead of the Employee ID when signing into the workstation.Example:
2121 -
checkName:
string
Name to print on guest checks.Example:
Employee Check Name -
dataExtensions:
array dataExtensions
An array of data extensions for employees
-
email:
string
Email address of the employee.Example:
employee@restaurant.com -
emcVisibility:
array emcVisibility
Array of hierarchy units visible to the employee in EMC.
-
firstName:
string
Employee's first name, which prints on reports.Example:
Employee -
group:
integer
The group of the employee.Example:
1 -
hasFingerprintEnrolled:
boolean
Flag indicating if the employee has its fingerprint enrolled. This flag cannot be modified by API.Example:
false -
id:
integer
ID number to identify the employee on workstations.Example:
2021 -
infoLine1:
string
Information line 1Example:
Information line 1 -
infoLine2:
string
Information line 2Example:
Information line 2 -
infoLine3:
string
Information line 3Example:
Information line 3 -
infoLine4:
string
Information line 4Example:
Information line 4 -
isDataPrivacyConsentGranted:
boolean
The consent status of the employee.Example:
false -
isDeleted:
boolean
Flag indicating if the employee record is deleted. If true, the record cannot be edited.Example:
false -
langId:
integer
Language IdExample:
1 -
languageObjNum:
integer
The object number of the default language for the employee on the EMC and the workstation.Example:
1 -
lastName:
string
Employee's last name, which prints on reports.Example:
Employee -
level:
integer
The level of the employee. This value should be between 1-9.Example:
1 -
localeObjNum:
integer
The object number of the locale of the employeeExample:
1 -
objectNum:
integer
Unique reference of the employee in the system.Example:
1 -
payrollId:
string
External payroll ID for the employee.Example:
EMP-01 -
pin:
string
PIN for the employee.Example:
2222 -
properties:
array properties
Array of properties where the employee is assigned.
-
roles:
array roles
An array of roles associated with the employee at different hierarchy levels
-
terminationDate:
string
The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be addedExample:
2021-11-21T00:00:00.000Z -
userName:
string
The login name for the EMC.Example:
empName
Nested Schema : emcVisibility
Type:
arrayArray of hierarchy units visible to the employee in EMC.
Show Source
Nested Schema : properties
Type:
arrayArray of properties where the employee is assigned.
Show Source
Nested Schema : roles
Type:
arrayAn array of roles associated with the employee at different hierarchy levels
Show Source
Nested Schema : Employee_dataExtensions
Type:
Show Source
object-
columnName:
string
Name of the extention fieldExample:
extension column 1 -
value:
string
Value of the extention fieldExample:
value 1
Nested Schema : Employee_emcVisibilityv2
Type:
Show Source
object-
hierUnitId:
integer
Unique reference of the hierarchy unit where the employee EMC visibility is configuredExample:
3599 -
hierUnitObjNum:
integer
Object number of the hierarchy unit where the employee EMC visibility is configuredExample:
26 -
propagateToChildren:
boolean
Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unitExample:
true
Nested Schema : Employee_propertiesv2
Type:
Show Source
object-
empClassObjNum:
integer
Object number of the class of the employee at the property.Example:
1 -
inTraining:
boolean
Flag indicating if employee is in training at the property.Example:
false -
jobCodes:
array jobCodes
Array of job codes assigned to the employee at the property
-
lateClockInGrace:
integer
The number of minutes that the employee can clock in late without being prompted or requiring authorization.Example:
1 -
ldsId:
integer
unique ID number to identify the employee in a Liquor Dispensing System.Example:
1 -
operators:
array operators
Array of revenue center operators records for the employees
-
options:
string
A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the employee property assignment.Example:
0000000000000000 -
optionsExt:
object Employee_properties_optionsExt
-
propertyHierUnitId:
integer
Unique hierarchy unit value associated with the propertyExample:
1 -
propertyObjNum:
integer
Hierarchy unit object number associated with the propertyExample:
1 -
rvcHierUnitId:
integer
Unique hierarchy unit value associated with the RVC.Example:
1 -
rvcObjNum:
integer
Hierarchy unit object number associated with the RVC.Example:
1
Nested Schema : jobCodes
Type:
arrayArray of job codes assigned to the employee at the property
Show Source
Nested Schema : operators
Type:
arrayArray of revenue center operators records for the employees
Show Source
Nested Schema : Employee_properties_optionsExt
Type:
Show Source
object-
disableWorkstationOnlinePrompt:
boolean
Flag indicating to allow offline workstations to automatically re-establish communication with the data center.Example:
false -
limitClkInToWorkstationsInTheClkInRVC:
boolean
Flag indicating to prevent the employee from clocking in unless the revenue center of the Clock-In Cycle matches the revenue center on the workstation.Example:
false -
limitClkOutToWorkstationsInTheClkOutRVC:
boolean
Flag indicating to prevent the employee from clocking out, unless the Current RVC field for the employee matches the revenue center on the workstation.Example:
false
Nested Schema : Employee_properties_jobCodesv2
Type:
Show Source
object-
jobCodeObjNum:
integer
Object number of the job codeExample:
1 -
otPayRate:
number
Overtime pay rate for the employee in the specified job codeExample:
2.5 -
regularPayRate:
number
Regular pay rate for the employee in the specified job codeExample:
1.23
Nested Schema : Employee_properties_operatorsv2
Type:
Show Source
object-
cashDrawerObjNum:
integer
Object number of the cash drawer that is permanently assigned to each workstation operator.Example:
1 -
cashierObjNum:
integer
Object number of the cashier linked to the workstation operator.Example:
1 -
cmAccountingMethodName:
string
Name of Cash Management sessionExample:
Session1 -
cmAccountingMethodObjNum:
integer
Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue centerExample:
1 -
options:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the employee operator record at the property.Example:
00000000000000000000000000000000 -
optionsExt:
object Employee_operators_optionsExt
-
overrideEmployeeClassOptions:
boolean
A flag indicating whether the workstation operator record uses Employee Class Options or Operator Options to determine transaction behavior.Example:
true -
rvcHierUnitId:
integer
Unique hierarchy unit value of the revenue centerExample:
1 -
rvcObjNum:
integer
Hierarchy unit object number associated with the revenue centerExample:
1 -
serverBankingTemplateObjNum:
integer
Object number of the default template to use when opening a server bank.Example:
1 -
serverEfficiency:
integer
Efficiency of the server.Example:
1 -
tableCount:
integer
The number of tables each operator serves.Example:
1 -
tmsColorObjName:
string
TMS Color NameExample:
TMS1 -
tmsColorObjNum:
integer
Object number of the color to distinguish the employee from others when using TMS.Example:
1
Nested Schema : Employee_operators_optionsExt
Type:
Show Source
object-
allowAssignedReceptacleAccess:
boolean
Flag indicating to allow workstation operators to view and perform transactions for till and server bank receptacles when the workstation operator is not the owner or assigned user.Example:
false -
cannotPerformFastTransactions:
boolean
Flag indicating to require opening a check to begin each transaction.Example:
false -
enableAutoPopUpEntryForStaydownOperator:
boolean
Flag indicating to automatically sign out a staydown operator based on the Automatic Operator Popup Interval setting in Control Parameters. Deselect to allow staydown operators to remain signed on to the workstation.Example:
false -
isPopupOperator:
boolean
Flag indicating to sign the operator out of the workstation at the end of a transaction.Example:
false -
onDemand:
boolean
Flag reflecting assignment of operator type 1. Only one of onDemand, tempOnDemand, specialByRound can be enabled at one once.Example:
false -
preventMultipleReceptacleCounts:
boolean
Flag indicating to prevent workstation operators from counting a till or server bank receptacle more than once.Example:
false -
preventTransactionsOnceCountIsPerformed:
boolean
Flag indicating to prevent operator from performing transactions once a count has occurred when option 27 (Prevent multiple receptacle counts) is enabled.Example:
false -
requireAuthForCashDrawerReconnection:
boolean
Flag indicating whether to enable authorization for a cash drawer cable reconnection on a workstation.Example:
false -
requireAuthForPowerCycleOfUWSDuringOperations:
boolean
Flag indicating whether or not to authorize a Power Cycle of a workstation. If a workstation operator has the Require Authorization for Power Cycle of UWS during Operations option enabled, an authorization code is required before performing another transaction.Example:
false -
requireCheckEmpNumberForNewChecks:
boolean
Flag indicating to require assignment of a check employee when beginning a check.Example:
false -
requireGuestCheckId:
boolean
Flag indicating to require checks opened or picked up by the workstation operator to have a Guest Check ID.Example:
false -
requireNumberOfGuestsEntryForNewChecks:
boolean
Flag indicating to require number of guests entry when beginning a check.Example:
false -
requireSeatNumberEntry:
boolean
Flag indicating to require the operator to have an active seat number when beginning a transaction.Example:
false -
requireTableNumberEntryToBeginOrPickupChecks:
boolean
Flag indicating to require table number entry when beginning a check.Example:
false -
sortGuestCheckSLUByTableName:
boolean
Flag indicating to sort the Open Checks SLU for the workstation operator by Table Name.Example:
false -
specialByRound:
boolean
Flag reflecting assignment of operator type 3. Only one of onDemand, tempOnDemand, specialByRound can be enabled at one once.Example:
false -
tempOnDemand:
boolean
Flag reflecting assignment of operator type 2. Only one of onDemand, tempOnDemand, specialByRound can be enabled at one once.Example:
false -
useEmpNumberToOpenCheckForAnotherEmployee:
boolean
Flag indicating to require entry of the Employee Number of the workstation operator for whom the check is being started. Deselect to require Employee ID entry of the other workstation operator.Example:
false -
viewBlindTotals:
boolean
Flag indicating to allow workstation operators to view over and under calculations on count sheets.Example:
false
Nested Schema : Employee_rolesv2
Type:
Show Source
object-
hierUnitId:
integer
Unique reference of the hierarchy unit where the employee role is configuredExample:
3599 -
hierUnitObjNum:
integer
Object number of the hierarchy unit where the employee role is configuredExample:
26 -
roleObjNum:
integer
The object number of the employee roleExample:
1000