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 : EmployeeJobCodesGetRequestBodyv2
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 -
langIds:
string
If specified, limits the translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.
-
objectNum(required):
integer
Object number of the employee
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.
-
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
propertyHierUnitId(required):
integer
Unique reference of the hierarchy unit associated with the property
-
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 associated job codes of a particular employee in an organization.
Root Schema : EmployeeJobCodeGetResponsev2
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
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