Update basic employees
post
/config/sim/v1/employees/updateEmployees2
Updates the basic 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.
Basic Employee Request Body
Root Schema : Employee2CURequestBody
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
-
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 -
isDeleted:
boolean
Flag indicating if the employee record is deleted.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:
integer
PIN for the employee.Example:
2222 -
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 : 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
Response
Supported Media Types
- application/json
200 Response
Response Object
Root Schema : Employee2Response
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