Get Employee Properties
post
/config/sim/v1/employees/getProperties
Gets all the properties to which the given employee is assigned in the specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : EmployeePropertyGetRequestBody
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 -
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 Properties of the employee
Root Schema : EmployeePropertyGetResponse
Type:
Show Source
object-
count(required):
integer
Current response record count.Example:
9 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of 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 : EmployeeProperty
Type:
Show Source
object-
empClassName(required):
object EmployeeClassNameTranslatedString
A string that contains translations of Employee class name into multiple languages
-
empClassObjNum(required):
integer
Object number of the class of the employee at the property.Example:
1 -
inTraining(required):
boolean
Flag indicating if employee is in training at the property.Example:
false -
jobCodes(required):
array jobCodes
Array of job codes assigned to the employee at the property
-
lateClockInGrace(required):
integer
The number of minutes that the employee can clock in late without being prompted or requiring authorization.Example:
1 -
ldsId(required):
integer
unique ID number to identify the employee in a Liquor Dispensing System.Example:
1 -
objectNum(required):
integer
Unique reference of the employee in the system.Example:
1 -
operators(required):
array operators
Array of revenue center operators records for the employees
-
options(required):
string
A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the employee property assignment.Example:
0000000000000000 -
optionsExt(required):
object Employee_properties_optionsExt
-
propertyHierUnitId(required):
integer
Unique hierarchy unit value associated with the propertyExample:
1 -
propertyName(required):
object PropertyNameTranslatedString
A string that contains translations of property name into multiple languages
-
propertyObjNum:
integer
Hierarchy unit object number associated with the propertyExample:
1 -
rvcHierUnitId(required):
integer
Unique hierarchy unit value associated with the RVC.Example:
1 -
rvcName(required):
object PropertyNameTranslatedString
A string that contains translations of property name into multiple languages
-
rvcObjNum(required):
integer
Hierarchy unit object number associated with the RVC.Example:
1
Nested Schema : EmployeeClassNameTranslatedString
Type:
objectA string that contains translations of Employee class name into multiple languages
Example:
{
"en-US":"Employee class",
"de-DE":"Mitarbeiterklasse",
"es-MX":"Clase de empleado"
}Nested Schema : jobCodes
Type:
arrayArray of job codes assigned to the employee at the property
Show Source
Nested Schema : operators
Type:
arrayArray of revenue center operators records for the employees
Show Source
Nested Schema : Employee_properties_optionsExt
Type:
Show Source
object-
disableWorkstationOnlinePrompt:
boolean
Flag indicating to allow offline workstations to automatically re-establish communication with the data center.Example:
false -
limitClkInToWorkstationsInTheClkInRVC:
boolean
Flag indicating to prevent the employee from clocking in unless the revenue center of the Clock-In Cycle matches the revenue center on the workstation.Example:
false -
limitClkOutToWorkstationsInTheClkOutRVC:
boolean
Flag indicating to prevent the employee from clocking out, unless the Current RVC field for the employee matches the revenue center on the workstation.Example:
false
Nested Schema : PropertyNameTranslatedString
Type:
objectA string that contains translations of property name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : Employee_properties_jobCodes
Type:
Show Source
object-
jobCodeName:
object JobCodeNameTranslatedString
A string that contains translations of employee job code name into multiple languages
-
jobCodeObjNum:
integer
Object number of the job codeExample:
1 -
otPayRate:
number
Overtime pay rate for the employee in the specified job codeExample:
2.5 -
regularPayRate:
number
Regular pay rate for the employee in the specified job codeExample:
1.23
Nested Schema : JobCodeNameTranslatedString
Type:
objectA string that contains translations of employee job code name into multiple languages
Example:
{
"en-US":"Job Code",
"es-MX":"C??digo de Trabajo"
}Nested Schema : Employee_properties_operators
Type:
Show Source
object-
cashDrawerObjNum:
integer
Object number of the cash drawer that is permanently assigned to each workstation operator.Example:
1 -
cashierName:
object CashierNameTranslatedString
A string that contains translations of Employee property job codes into multiple languages
-
cashierObjNum:
integer
Object number of the cashier linked to the workstation operator.Example:
1 -
cmAccountingMethodName:
string
Name of Cash Management sessionExample:
Session1 -
cmAccountingMethodObjNum:
integer
Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue centerExample:
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 -
rvcHierUnitId:
integer
Unique hierarchy unit value of the revenue centerExample:
1 -
rvcName:
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
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 NameExample:
TMS1 -
tmsColorObjNum:
integer
Object number of the color to distinguish the employee from others when using TMS.Example:
1
Nested Schema : CashierNameTranslatedString
Type:
objectA string that contains translations of Employee property job codes into multiple languages
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 : HierUnitNameTranslatedString
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}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