Get Employee Roles
post
/config/sim/v1/employees/getEmployeeRoles
Gets a list of all the roles associated with the given employee in the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : EmployeeRoleBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
-
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
-
limit:
integer
-
objectNum(required):
integer
-
offset:
integer
-
orderBy:
string
-
searchCriteria:
string
Response
Supported Media Types
- application/json
200 Response
A collection of associated roles of a particular employee in an organization.
Root Schema : EmployeeRole
Type:
objectModel for an Employee Role Object
Show Source
-
hierUnitId(required):
integer
Unique reference of the hierarchy unit where the employee role is configuredExample:
3599 -
hierUnitName(required):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unit where the employee role is configuredExample:
26 -
objectNum(required):
integer
Unique reference of the employee in the system.Example:
1 -
roleEmployeeId(required):
integer
Unique reference of Employee Role AssociationExample:
1 -
roleName(required):
object RoleNameTranslatedString
A string that contains translations of employee role name into multiple languages
-
roleObjNum(required):
integer
The object number of the role assigned to the employeeExample:
1000
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"
}Nested Schema : RoleNameTranslatedString
Type:
objectA string that contains translations of employee role name into multiple languages
Example:
{
"en-US":"Cashier",
"de-DE":"Kassierer",
"es-MX":"Cajero"
}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