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 : schema
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in the response.Example:
hierUnitId -
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 the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
0 -
objectNum(required):
integer
Object number of employeeExample:
1 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
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 value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Employee Roles.
Root Schema : EmployeeRoleGetResponsev1
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 Role 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 Role objects of the organization.
Show Source
-
Array of:
object EmployeeRolev1
Model for an Employee Role Object
Nested Schema : EmployeeRolev1
Type:
objectModel for an Employee Role Object
Show Source
-
hierUnitId:
integer
Unique reference of the hierarchy unit where the employee role is configuredExample:
3599 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unit where the employee role is configuredExample:
26 -
objectNum:
integer
Unique reference of the employee in the system.Example:
1 -
roleEmployeeId:
integer
Unique reference of Employee Role AssociationExample:
1 -
roleName:
object roleName
Role Name
-
roleObjNum:
integer
The object number of the role assigned to the employeeExample:
1000
Nested Schema : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : roleName
Type:
objectRole Name
Example:
{
"en-US":"Cashier",
"de-DE":"Kassierer",
"es-MX":"Cajero"
}