Get Employee Job Codes
post
/config/sim/v2/employees/properties/getJobCodes
Gets all the job codes assigned to the given employee at the specified property
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : schema
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum -
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 -
objectNum(required):
integer
Object number of the employeeExample:
1 -
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 -
propertyHierUnitId(required):
integer
Unique reference of the hierarchy unit associated with the propertyExample:
2 -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(objectNum, 1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Employee Job Codes.
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 Job Code 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 Job Code objects of the organization.
Show Source
-
Array of:
object EmployeeJobCodev2
Model for an Employee Job Code Object
Nested Schema : EmployeeJobCodev2
Type:
objectModel for an Employee Job Code Object
Show Source
-
jobCodeObjNum:
integer
The object number of the employee job codeExample:
1 -
objectNum:
integer
Unique reference of the employee in the system.Example:
1 -
otPayRate:
number
Overtime pay rate for the employee in the specified job codeExample:
20.5 -
propertyHierUnitId:
integer
Unique reference of the hierarchy unit associated with the propertyExample:
3599 -
propertyObjNum:
integer
Object number of the hierarchy unit associated with the propertyExample:
5 -
regularPayRate:
number
Regular pay rate for the employee in the specified job codeExample:
10.75 -
reportGroup:
integer
Object number of the Report Group.Example:
1