Get Employee Classes
post
/config/sim/v2/employees/getClasses
Gets all Employees Classes
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
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 -
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
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 Classes 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 Classes objects of the organization.
Show Source
Nested Schema : EmployeeClassV2
Type:
Show Source
object-
className:
object className
-
cmAccountingMethodName:
string
Name of Cash Management session type the employee uses to record Cash Management related transactions within the revenue centerExample:
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 -
dataExtensions:
array dataExtensions
An array of data extensions for Employee Class Revenue Center Operator Options
-
hierUnitId:
integer
Unique hierarchy unit valueExample:
1 -
hierUnitObjNum:
integer
Hierarchy unit object numberExample:
2 -
islOptions:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the employee property assignment.Example:
00000000 -
islOptionsExt:
object isl_optionsExt
-
objectNum:
integer
Unique reference of the employee class.Example:
1 -
rvcOperatorOptions:
array rvcOperatorOptions
An array of revenue center operator options
-
serverBankingTemplateObjNum:
integer
Object number of the default template to use when opening a server bank.Example:
1
Nested Schema : className
Type:
objectExample:
{
"1":"Employee class",
"2":"Mitarbeiterklasse",
"3":"Clase de empleado"
}Nested Schema : dataExtensions
Type:
arrayAn array of data extensions for Employee Class Revenue Center Operator Options
Show Source
Nested Schema : isl_optionsExt
Type:
Show Source
object-
islEmployeeOption1:
boolean
Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \#1 enabled.Example:
false -
islEmployeeOption2:
boolean
Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \#2 enabled.Example:
false -
islEmployeeOption3:
boolean
Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \#3 enabled.Example:
false -
islEmployeeOption4:
boolean
Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \#4 enabled.Example:
false -
islEmployeeOption5:
boolean
Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \#5 enabled.Example:
false -
islEmployeeOption6:
boolean
Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \#6 enabled.Example:
false -
islEmployeeOption7:
boolean
Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \#7 enabled.Example:
false -
islEmployeeOption8:
boolean
Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \#8 enabled.Example:
false
Nested Schema : rvcOperatorOptions
Type:
arrayAn array of revenue center operator options
Show Source
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
Nested Schema : EmployeeClass_rvcOperatorOptionsV2
Type:
Show Source
object-
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