Get basic employees
post
/config/sim/v1/employees/getEmployees2
Gets all the basic employees information
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : Employee2GetRequestBody
Type:
Show Source
object-
include:
string
Example:
locations -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits translated strings returned.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of employees of the organization with all basic information
Root Schema : Employee2GetResponse
Type:
Show Source
object-
count(required):
integer
Current response recount count.Example:
9 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of basic employee objects of the organization.
-
limit(required):
integer
Server page sizeExample:
10 -
offset(required):
integer
Starting resource record indexExample:
0 -
totalResults(required):
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : Employee2
Type:
Show Source
object-
alternateId(required):
integer
ID to use instead of the Employee ID when signing into the workstation.Example:
2121 -
checkName(required):
string
Name to print on guest checks.Example:
Employee Check Name -
dataExtensions(required):
array dataExtensions
An array of data extensions for employees
-
email(required):
string
Email address of the employee.Example:
employee@restaurant.com -
firstName(required):
string
Employee's first name, which prints on reports.Example:
Employee -
group(required):
integer
The group of the employee.Example:
1 -
hasFingerprintEnrolled(required):
boolean
Flag indicating if the employee has its fingerprint enrolled. This flag cannot be modified by API.Example:
false -
id(required):
integer
ID number to identify the employee on workstations.Example:
2021 -
infoLine1(required):
string
Information line 1Example:
Information line 1 -
infoLine2(required):
string
Information line 2Example:
Information line 2 -
infoLine3(required):
string
Information line 3Example:
Information line 3 -
infoLine4(required):
string
Information line 4Example:
Information line 4 -
isDataPrivacyConsentGranted(required):
boolean
The consent status of the employee.Example:
false -
isDeleted(required):
boolean
Flag indicating if the employee record is deleted.Example:
false -
language(required):
string
The default language for the employee on the EMC and the workstation.Example:
English -
languageObjNum(required):
integer
The object number of the default language for the employee on the EMC and the workstation.Example:
1 -
lastName(required):
string
Employee's last name, which prints on reports.Example:
Employee -
level(required):
integer
The level of the employee. This value should be between 1-9.Example:
1 -
locale(required):
string
Locale for the employee to use in the EMC.Example:
en-US -
localeObjNum(required):
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(required):
string
External payroll ID for the employee.Example:
EMP-01 -
pin(required):
integer
PIN for the employee.Example:
2222 -
terminationDate(required):
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(required):
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
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
404 Response
404 Requested resource not found