Add Employee
post
/config/sim/v1/employees/employees
Add the Employee object to a specified hierarchy unit of specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Employee Request Body
Root Schema : EmployeeInsertRequestBody
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
-
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 -
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 -
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(required):
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_emcVisibility_CUD
Type:
Show Source
object-
hierUnitId:
integer
Unique reference of the hierarchy unit where the employee EMC visibility is configuredExample:
3599 -
propagateToChildren:
boolean
Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unitExample:
true
Nested Schema : Employee_properties_CUD
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 -
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 -
propertyHierUnitId:
integer
Unique hierarchy unit value associated with the propertyExample:
1 -
rvcHierUnitId:
integer
Unique hierarchy unit value associated with the RVC.Example:
1
Nested Schema : operators
Type:
arrayArray of revenue center operators records for the employees
Show Source
Nested Schema : Employee_properties_operators_CUD
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 -
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 -
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 -
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 -
tmsColorObjNum:
integer
Object number of the color to distinguish the employee from others when using TMS.Example:
1
Nested Schema : Employee_roles_CUD
Type:
Show Source
object-
hierUnitId:
integer
Unique reference of the hierarchy unit where the employee role is configuredExample:
3599 -
roleObjNum:
integer
The object number of the employee roleExample:
1000
Response
Supported Media Types
- application/json
200 Response
Response Object
Root Schema : EmployeeResponse
Type:
Show Source
object-
objectNum(required):
integer
Unique reference of the EmployeeExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html