Update Employee Properties
post
/config/sim/v1/employees/updateProperties
Updates the property assigned to the Employee at the specified hierarchy unit. If Employee property is not found, it assigns the property to the Employee.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Request body
Root Schema : EmployeePropertyCUDRequestBody
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 -
objectNum(required):
integer
Unique reference of the employee in the 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(required):
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
Response
Supported Media Types
- application/json
200 Response
Response Object
Nested Schema : 0
Type:
objectNested Schema : EmployeePropertyResponse
Type:
Show Source
object-
objectNum(required):
integer
Unique reference of the EmployeeExample:
1 -
propertyHierUnitId(required):
integer
Unique hierarchy unit value of the propertyExample:
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