Get Employee Property Operators
post
/config/sim/v1/employees/properties/getOperators
Gets all the operator records for the given employee at the assigned property in the specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : EmployeePropertyJobCodeGetRequestBody
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 -
objectNum(required):
integer
Unique reference of the EmployeeExample:
1 -
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 -
propertyHierUnitId(required):
integer
Unique hierarchy unit value of the propertyExample:
1 -
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 Employee Property Operators.
Root Schema : EmployeePropertyOperatorGetResponse
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 Property 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:
arrayArray of Employee Property Operator objects of the organization.
Show Source
Nested Schema : EmployeePropertyOperatorv1
Type:
Show Source
object-
cashDrawerObjNum:
integer
Object number of the cash drawer that is permanently assigned to each workstation operator.Example:
1 -
cashierName:
object cashierName
Cashier Name
-
cashierObjNum:
integer
Object number of the cashier linked to the workstation operator.Example:
1 -
cmAccountingMethodName:
string
CM Accounting Method NameExample:
Till Banking -
cmAccountingMethodObjNum:
integer
Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue centerExample:
1 -
objectNum:
integer
Unique reference of the employee in the system.Example:
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 -
optionsExt:
object Employee_operators_optionsExt
-
overrideEmployeeClassOptions:
boolean
A flag indicating whether the workstation operator record uses Employee Class Options or Operator Options to determine transaction behavior.Example:
true -
propertyHierUnitId:
integer
Unique hierarchy unit value associated with the propertyExample:
1 -
propertyName:
object propertyName
Property Name
-
propertyObjNum:
integer
Hierarchy unit object number associated with the propertyExample:
1 -
rvcHierUnitId:
integer
Unique hierarchy unit value of the revenue centerExample:
1 -
rvcName:
object rvcName
RVC Name
-
rvcObjNum:
integer
Hierarchy unit object number associated with 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 -
tmsColorObjName:
string
TMS Color Obj Name.Example:
Blanco -
tmsColorObjNum:
integer
Object number of the color to distinguish the employee from others when using TMS.Example:
1
Nested Schema : cashierName
Type:
objectCashier Name
Example:
{
"en-US":"Cashier",
"de-DE":"Kassierer",
"es-MX":"Cajero"
}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
Nested Schema : propertyName
Type:
objectProperty Name
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : rvcName
Type:
objectRVC Name
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}