Configuration and Content API Guide

Get Employee Job Codes

post

/config/sim/v1/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 : EmployeeJobCodesGetRequestBodyv1

Type: object

The input Body model that needs to be given.

Show Source

include: string

Objects included in response

Example: objectNum
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 translated strings returned

Example: en-US, es-ES, es-MX
limit: integer

If using paging, number of results returned in this page.

Example: 100
objectNum(required): integer

Object number of the employee

Example: 2
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
propertyHierUnitId(required): integer

Unique reference of the hierarchy unit associated with the property

Example: 2
searchCriteria: string

Search criteria to filter results based on field value

Example: where equals(objectNum, 2)

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "required":[
        "propertyHierUnitId",
        "objectNum"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum, 2)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"objectNum",
            "description":"Objects included in response"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"en-US, es-ES, es-MX"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "objectNum":{
            "type":"integer",
            "description":"Object number of the employee",
            "example":2
        },
        "propertyHierUnitId":{
            "type":"integer",
            "description":"Unique reference of the hierarchy unit associated with the property",
            "example":2
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Employee Job Codes.

Root Schema : EmployeeJobCodeGetResponsev1

Type: object

Show Source

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 size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Employee Job Code objects of the organization.",
            "items":{
                "$ref":"#/definitions/EmployeeJobCodev1"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Employee Job Code objects of the organization.

Show Source

Array of: object EmployeeJobCodev1

Model for an Employee Job Code Object

{
    "type":"array",
    "description":"Array of Employee Job Code objects of the organization.",
    "items":{
        "$ref":"#/definitions/EmployeeJobCodev1"
    }
}

Nested Schema : EmployeeJobCodev1

Type: object

Model for an Employee Job Code Object

Show Source

jobCodeName: object jobCodeName

Job Code Name
jobCodeObjNum: integer

The object number of the employee job code

Example: 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 code

Example: 20.5
propertyHierUnitId: integer

Unique reference of the hierarchy unit associated with the property

Example: 3599
propertyName: object propertyName

Property Name.
propertyObjNum: integer

Object number of the hierarchy unit associated with the property

Example: 5
regularPayRate: number

Regular pay rate for the employee in the specified job code

Example: 10.75
reportGroup: integer

Object number of the Report Group.

Example: 1

{
    "description":"Model for an Employee Job Code Object",
    "type":"object",
    "properties":{
        "objectNum":{
            "description":"Unique reference of the employee in the system.",
            "type":"integer",
            "example":1
        },
        "propertyHierUnitId":{
            "description":"Unique reference of the hierarchy unit associated with the property",
            "type":"integer",
            "example":3599
        },
        "propertyObjNum":{
            "description":"Object number of the hierarchy unit associated with the property",
            "type":"integer",
            "example":5
        },
        "propertyName":{
            "type":"object",
            "description":"Property Name.",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "es-MX":"Propiedad"
            }
        },
        "jobCodeObjNum":{
            "description":"The object number of the employee job code",
            "type":"integer",
            "example":1
        },
        "jobCodeName":{
            "type":"object",
            "description":"Job Code Name",
            "example":{
                "en-US":"Job Code",
                "es-MX":"C??digo de Trabajo"
            }
        },
        "regularPayRate":{
            "description":"Regular pay rate for the employee in the specified job code",
            "type":"number",
            "example":10.75
        },
        "otPayRate":{
            "description":"Overtime pay rate for the employee in the specified job code",
            "type":"number",
            "example":20.5
        },
        "reportGroup":{
            "description":"Object number of the Report Group.",
            "type":"integer",
            "example":1
        }
    }
}

Nested Schema : jobCodeName

Type: object

Job Code Name

Example:

{
    "en-US":"Job Code",
    "es-MX":"C??digo de Trabajo"
}

Nested Schema : propertyName

Type: object

Property Name.

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "es-MX":"Propiedad"
}