Add Employee Classes
post
/config/sim/v1/employees/classes
Add the Employee class object to a specified hierarchy unit .
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Request body
Root Schema : EmployeeClassCUDRequestBody
Type:
Show Source
object-
className(required):
object EmployeeClassNameTranslatedString
A string that contains translations of Employee class name into multiple languages
-
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(required):
integer
Unique hierarchy unit valueExample:
1 -
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 -
objectNum(required):
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 : 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 : dataExtensions
Type:
arrayAn array of data extensions for Employee Class Revenue Center Operator Options
Show Source
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_rvcOperatorOptionsCU
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 -
rvcObjNum:
integer
Object number of the revenue center.Example:
1
Response
Supported Media Types
- application/json
200 Response
Response Object
Root Schema : EmployeeClassResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit value where the employee class is configuredExample:
2 -
objectNum(required):
integer
Object number of the Employee ClassExample:
1
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