Update Employees
post
/config/sim/v1/employees/updateEmployees
Updates the Employee. If Employee is not found is not found, it creates a new Employee.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
-
Simphony-OrgShortName: string
The ShortName of the organization
Employee Request Body
Root Schema : Employee
Type:
Show Source
object-
alternateId(optional):
integer
ID to use instead of the Employee ID when signing into the workstation.Example:
2121 -
checkName(optional):
string
Name to print on guest checks.Example:
Employee Check Name -
dataExtensions(optional):
array dataExtensions
An array of data extensions for employees
-
email(optional):
string
Email address of the employee.Example:
employee@restaurant.com -
emcVisibility(optional):
array emcVisibility
Array of hierarchy units visible to the employee in EMC.
-
firstName(optional):
string
Employee's first name, which prints on reports.Example:
Employee -
group(optional):
integer
The group of the employee.Example:
1 -
hasFingerprintEnrolled(optional):
boolean
Flag indicating if the employee has its fingerprint enrolled. This flag cannot be modified by API.Example:
false -
hierUnitId:
integer
Unique hierarchy unit value.Example:
1 -
id(optional):
integer
ID number to identify the employee on workstations.Example:
2021 -
infoLine1(optional):
string
Information line 1Example:
Information line 1 -
infoLine2(optional):
string
Information line 2Example:
Information line 2 -
infoLine3(optional):
string
Information line 3Example:
Information line 3 -
infoLine4(optional):
string
Information line 4Example:
Information line 4 -
isDataPrivacyConsentGranted(optional):
boolean
The consent status of the employee.Example:
false -
isDeleted(optional):
boolean
Flag indicating if the employee record is deleted.Example:
false -
language(optional):
string
The default language for the employee on the EMC and the workstation.Example:
English -
languageObjNum(optional):
integer
The object number of the default language for the employee on the EMC and the workstation.Example:
1 -
lastName(optional):
string
Employee's last name, which prints on reports.Example:
Employee -
level(optional):
integer
The level of the employee. This value should be between 1-9.Example:
1 -
locale(optional):
string
Locale for the employee to use in the EMC.Example:
en-US -
localeObjNum(optional):
integer
The object number of the locale of the employeeExample:
1 -
objectNum:
integer
Unique reference of the employee in the system.Example:
1 -
payrollId(optional):
string
External payroll ID for the employee.Example:
EMP-01 -
pin(optional):
integer
PIN for the employee.Example:
2222 -
properties(optional):
array properties
Array of properties where the employee is assigned.
-
roles(optional):
array roles
An array of roles associated with the employee at different hierarchy levels
-
terminationDate(optional):
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(optional):
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(optional):
string
Name of the extention fieldExample:
extension column 1 -
value(optional):
string
Value of the extention fieldExample:
value 1
Nested Schema : Employee_emcVisibility
Type:
Show Source
object-
hierUnitId(optional):
integer
Unique reference of the hierarchy unit where the employee EMC visibility is configuredExample:
3599 -
hierUnitName(optional):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(optional):
integer
Object number of the hierarchy unit where the employee EMC visibility is configuredExample:
26 -
propagateToChildren(optional):
boolean
Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unitExample:
true
Nested Schema : HierUnitNameTranslatedString
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"ar-AR":"??????????"
}Nested Schema : Employee_properties
Type:
Show Source
object-
employeeClassName(optional):
object EmployeeClassNameTranslatedString
A string that contains translations of Employee class name into multiple languages
-
employeeClassObjNum(optional):
integer
Object number of the class of the employee at the property.Example:
1 -
inTraining(optional):
boolean
Flag indicating if employee is in training at the property.Example:
false -
jobCodes(optional):
array jobCodes
Array of job codes assigned to the employee at the property
-
lateClockInGrace(optional):
integer
The number of minutes that the employee can clock in late without being prompted or requiring authorization.Example:
1 -
ldsId(optional):
integer
unique ID number to identify the employee in a Liquor Dispensing System.Example:
1 -
operators(optional):
array operators
Array of revenue center operators records for the employees
-
options(optional):
string
A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the employee property assignment.Example:
0000 -
optionsExt(optional):
object Employee_properties_optionsExt
-
propertyHierUnitId(optional):
integer
Unique hierarchy unit value associated with the propertyExample:
1 -
propertyName(optional):
object PropertyNameTranslatedString
A string that contains translations of property name into multiple languages
-
propertyObjNum(optional):
integer
Hierarchy unit object number associated with the propertyExample:
1 -
rvcHierUnitId(optional):
integer
Unique hierarchy unit value associated with the RVC.Example:
1 -
rvcName(optional):
object PropertyNameTranslatedString
A string that contains translations of property name into multiple languages
-
rvcObjNum(optional):
integer
Hierarchy unit object number associated with the RVC.Example:
1
Nested Schema : EmployeeClassNameTranslatedString
Type:
objectA string that contains translations of Employee class name into multiple languages
Example:
{
"en-US":"Employee class",
"de-DE":"Mitarbeiterklasse",
"ar-AR":"?????? ????????????"
}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(optional):
boolean
Flag indicating to allow offline workstations to automatically re-establish communication with the data center.Example:
false -
limitClkInToWorkstationsInTheClkInRVC(optional):
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(optional):
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 : PropertyNameTranslatedString
Type:
objectA string that contains translations of property name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"ar-AR":"??????????"
}Nested Schema : Employee_properties_jobCodes
Type:
Show Source
object-
jobCodeName(optional):
object JobCodeNameTranslatedString
A string that contains translations of employee job code name into multiple languages
-
jobCodeObjNum(optional):
integer
Object number of the job codeExample:
1 -
otPayRate(optional):
number
Overtime pay rate for the employee in the specified job codeExample:
2.5 -
regularPayRate(optional):
number
Regular pay rate for the employee in the specified job codeExample:
1.23
Nested Schema : JobCodeNameTranslatedString
Type:
objectA string that contains translations of employee job code name into multiple languages
Example:
{
"en-US":"job code1",
"ar-AR":"?????? ??????????????"
}Nested Schema : Employee_properties_operators
Type:
Show Source
object-
cashDrawerObjNum(optional):
integer
Object number of the cash drawer that is permanently assigned to each workstation operator.Example:
1 -
cashierName(optional):
object CashierNameTranslatedString
A string that contains translations of Employee property job codes into multiple languages
-
cashierObjNum(optional):
integer
Object number of the cashier linked to the workstation operator.Example:
1 -
cmAccountingMethodName(optional):
object CmAccountingMethodNameTranslatedString
A string that contains translations of cmAccountingMethodName into multiple languages
-
cmAccountingMethodObjNum(optional):
integer
Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue centerExample:
1 -
operatorType(optional):
integer
Guest check printing method for operators assigned to this Employee Class.Example:
1 -
options(optional):
string
A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the employee operator record at the property.Example:
0000 -
optionsExt(optional):
object Employee_operators_optionsExt
-
overrideEmployeeClassOptions(optional):
boolean
A flag indicating whether the workstation operator record uses Employee Class Options or Operator Options to determine transaction behavior.Example:
true -
rvcHierUnitId(optional):
integer
Unique hierarchy unit value of the revenue centerExample:
1 -
rvcName(optional):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
rvcObjNum(optional):
integer
Hierarchy unit object number associated with the revenue centerExample:
1 -
serverBankingTemplateObjNum(optional):
integer
Object number of the default template to use when opening a server bank.Example:
1 -
serverEfficiency(optional):
integer
Efficiency of the server.Example:
1 -
tableCount(optional):
integer
The number of tables each operator serves.Example:
1 -
tmsColorObjName(optional):
object TmsColorObjNameTranslatedString
A string that contains translations of cmAccountingMethodName into multiple languages
-
tmsColorObjNum(optional):
integer
Object number of the color to distinguish the employee from others when using TMS.Example:
1
Nested Schema : CashierNameTranslatedString
Type:
objectA string that contains translations of Employee property job codes into multiple languages
Example:
{
"en-US":"Cashier",
"de-DE":"Kassierer",
"ar-AR":"???????? ??????????????"
}Nested Schema : CmAccountingMethodNameTranslatedString
Type:
objectA string that contains translations of cmAccountingMethodName into multiple languages
Example:
{
"en-US":"Till Banking",
"de-DE":"Bis zum Bankwesen",
"ar-AR":"?????? ????????????????"
}Nested Schema : Employee_operators_optionsExt
Type:
Show Source
object-
allowAssignedReceptacleAccess(optional):
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(optional):
boolean
Flag indicating to require opening a check to begin each transaction.Example:
false -
enableAutoPopUpEntryForStaydownOperator(optional):
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(optional):
boolean
Flag indicating to sign the operator out of the workstation at the end of a transaction.Example:
false -
preventMultipleReceptacleCounts(optional):
boolean
Flag indicating to prevent workstation operators from counting a till or server bank receptacle more than once.Example:
false -
preventTransactionsOnceCountIsPerformed(optional):
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 -
requireCheckEmpNumberForNewChecks(optional):
boolean
Flag indicating to require assignment of a check employee when beginning a check.Example:
false -
requireGuestCheckId(optional):
boolean
Flag indicating to require checks opened or picked up by the workstation operator to have a Guest Check ID.Example:
false -
requireNumberOfGuestsEntryForNewChecks(optional):
boolean
Flag indicating to require number of guests entry when beginning a check.Example:
false -
requireSeatNumberEntry(optional):
boolean
Flag indicating to require the operator to have an active seat number when beginning a transaction.Example:
false -
requireTableNumberEntryToBeginOrPickupChecks(optional):
boolean
Flag indicating to require table number entry when beginning a check.Example:
false -
sortGuestCheckSLUByTableName(optional):
boolean
Flag indicating to sort the Open Checks SLU for the workstation operator by Table Name.Example:
false -
useEmpNumberToOpenCheckForAnotherEmployee(optional):
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(optional):
boolean
Flag indicating to allow workstation operators to view over and under calculations on count sheets.Example:
false
Nested Schema : TmsColorObjNameTranslatedString
Type:
objectA string that contains translations of cmAccountingMethodName into multiple languages
Example:
{
"en-US":"White",
"de-DE":"Wei??",
"ar-AR":"????????"
}Nested Schema : Employee_roles
Type:
Show Source
object-
hierUnitId(optional):
integer
Unique reference of the hierarchy unit where the employee role is configuredExample:
3599 -
hierUnitName(optional):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(optional):
integer
Object number of the hierarchy unit where the employee role is configuredExample:
26 -
roleName(optional):
object RoleNameTranslatedString
A string that contains translations of employee role name into multiple languages
-
roleObjNum(optional):
integer
The object number of the employee roleExample:
1000
Nested Schema : RoleNameTranslatedString
Type:
objectA string that contains translations of employee role name into multiple languages
Example:
{
"en-US":"Cashier",
"de-DE":"Kassierer",
"ar-AR":"???????? ??????????????"
}Response
Supported Media Types
- application/json
200 Response
Response Object
Root Schema : EmployeeResponse
Type:
Show Source
object-
hierUnitId:
integer
Unique hierarchy unit value.Example:
1 -
objectNum:
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(optional):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(optional):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(optional):
integer
Error code of the problemExample:
55223 -
status(optional):
integer
HTTP status code.Example:
400 -
title(optional):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(optional):
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