Get Employee Class Operators
post
/config/sim/v2/employees/classes/getOperators
Gets all the operator options configured for employee class in the specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
A Request body
Root Schema : schema
Type:
Show Source
object
-
hierUnitId(required):
integer
Unique hierarchy unit value where the employee class is configured.Example:
1
-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name
-
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
-
objectNum(required):
integer
Object number of the Employee ClassExample:
1
-
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.Example:
hierUnitId:asc
-
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Employee Class Operators.
Root Schema : schema
Type:
Show Source
object
-
count:
integer
Current response record count.Example:
9
-
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true
-
items:
array items
Array of Employee Class Operator objects of the organization.
-
limit:
integer
Server page sizeExample:
10
-
offset:
integer
Starting resource record indexExample:
0
-
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
array
Array of Employee Class Operator objects of the organization.
Show Source
Nested Schema : EmployeeClassOperatorv2
Type:
Show Source
object
-
hierUnitId:
integer
Unique hierarchy unit valueExample:
1
-
hierUnitObjNum:
integer
Hierarchy unit object numberExample:
2
-
objectNum:
integer
Object number of the employee Class.Example:
1
-
options:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the Revenue Center Operator recordExample:
00000000000000000000000000000000
-
optionsExt:
object Employee_operators_optionsExt
-
rvcObjNum:
integer
Object number of the revenue center.Example:
1
Nested Schema : Employee_operators_optionsExt
Type:
Show Source
object
-
allowAssignedReceptacleAccess:
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:
boolean
Flag indicating to require opening a check to begin each transaction.Example:
false
-
enableAutoPopUpEntryForStaydownOperator:
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:
boolean
Flag indicating to sign the operator out of the workstation at the end of a transaction.Example:
false
-
onDemand:
boolean
Flag reflecting assignment of operator type 1. Only one of onDemand, tempOnDemand, specialByRound can be enabled at one once.Example:
false
-
preventMultipleReceptacleCounts:
boolean
Flag indicating to prevent workstation operators from counting a till or server bank receptacle more than once.Example:
false
-
preventTransactionsOnceCountIsPerformed:
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
-
requireAuthForCashDrawerReconnection:
boolean
Flag indicating whether to enable authorization for a cash drawer cable reconnection on a workstation.Example:
false
-
requireAuthForPowerCycleOfUWSDuringOperations:
boolean
Flag indicating whether or not to authorize a Power Cycle of a workstation. If a workstation operator has the Require Authorization for Power Cycle of UWS during Operations option enabled, an authorization code is required before performing another transaction.Example:
false
-
requireCheckEmpNumberForNewChecks:
boolean
Flag indicating to require assignment of a check employee when beginning a check.Example:
false
-
requireGuestCheckId:
boolean
Flag indicating to require checks opened or picked up by the workstation operator to have a Guest Check ID.Example:
false
-
requireNumberOfGuestsEntryForNewChecks:
boolean
Flag indicating to require number of guests entry when beginning a check.Example:
false
-
requireSeatNumberEntry:
boolean
Flag indicating to require the operator to have an active seat number when beginning a transaction.Example:
false
-
requireTableNumberEntryToBeginOrPickupChecks:
boolean
Flag indicating to require table number entry when beginning a check.Example:
false
-
sortGuestCheckSLUByTableName:
boolean
Flag indicating to sort the Open Checks SLU for the workstation operator by Table Name.Example:
false
-
specialByRound:
boolean
Flag reflecting assignment of operator type 3. Only one of onDemand, tempOnDemand, specialByRound can be enabled at one once.Example:
false
-
tempOnDemand:
boolean
Flag reflecting assignment of operator type 2. Only one of onDemand, tempOnDemand, specialByRound can be enabled at one once.Example:
false
-
useEmpNumberToOpenCheckForAnotherEmployee:
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:
boolean
Flag indicating to allow workstation operators to view over and under calculations on count sheets.Example:
false