Get System Employees
post
/config/sim/v2/employees/getSystemEmployees
Gets all System Employees
Request
Supported Media Types
- application/json
- multipart/form-data
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
objectNum, firstName -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Allowed fields are objectNum, firstName, lastName and checkName.Example:
objectNum:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are objectNum, firstName, lastName and checkName.Example:
where equals(objectnum, 1792)
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : schema
Type:
Show Source
object-
count:
integer
Number of records returned on this pageExample:
10 -
hasMore:
boolean
Indicates whether there are additional pages of recordsExample:
true -
items:
array items
System employee records
-
limit:
integer
The maximum number of records returned on a pageExample:
10 -
offset:
integer
The page number of this data. Starts at 0.Example:
0 -
totalResults:
integer
Total number of records in the data setExample:
100
Nested Schema : items
Type:
arraySystem employee records
Show Source
-
Array of:
object SystemEmployee
System employee record
Nested Schema : SystemEmployee
Type:
objectSystem employee record
Show Source
-
checkName:
string
Name to print on guest checks.Example:
SystemEmpCheckName -
firstName:
string
System employee's first name, which prints on reports.Example:
Employee -
hierUnitId:
integer
Unique reference of the hierarchy unit where the system employee is configured.Example:
3599 -
langId:
integer
LangId of default language for the system employeeExample:
1 -
lastName:
string
System employee's last name, which prints on reports.Example:
Employee -
objectNum:
integer
Object number of the system employee.Example:
1