Jump to

• Request
• Response

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

Header Parameters

• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

A request body

Root Schema : EmployeeJobCodesGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy.
• include(optional): string
  Objects included in response
• languages(optional): string
  If specified, limits translated strings returned
• limit(optional): integer
  If using paging, number of results returned in this page.
• objectNum: integer
  Object number of the employee
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported
• searchCriteria(optional): string
  Search criteria to filter results based on field value

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "objectNum":{
            "type":"integer",
            "description":"Object number of the employee"
        },
        "hierUnitId":{
            "type":"integer",
            "description":"Unique reference of the hierarchy."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of associated job codes of a particular employee in an organization.

Body ()

Root Schema : EmployeeJobCode

Type: object

Model for an Employee Job Code Object

Show Source

• jobCodeName(optional): object JobCodeNameTranslatedString
  A string that contains translations of employee job code name into multiple languages
• jobCodeObjNum(optional): integer
  The object number of the employee job code

  Example: 1
• objectNum(optional): integer
  Unique reference of the employee in the system.

  Example: 1
• otPayRate(optional): number
  Overtime pay rate for the employee in the specified job code

  Example: 20.5
• propertyHierUnitId(optional): integer
  Unique reference of the hierarchy unit associated with the property

  Example: 3599
• propertyName(optional): object HierUnitNameTranslatedString
  A string that contains translations of hierarchy unit name into multiple languages
• propertyObjNum(optional): integer
  Object number of the hierarchy unit associated with the property

  Example: 5
• regularPayRate(optional): number
  Regular pay rate for the employee in the specified job code

  Example: 10.75

{
    "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":{
            "$ref":"#/definitions/HierUnitNameTranslatedString"
        },
        "jobCodeObjNum":{
            "description":"The object number of the employee job code",
            "type":"integer",
            "example":1
        },
        "jobCodeName":{
            "$ref":"#/definitions/JobCodeNameTranslatedString"
        },
        "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
        }
    }
}

Nested Schema : JobCodeNameTranslatedString

Type: object

A string that contains translations of employee job code name into multiple languages

Example:

{
    "en-US":"job code1",
    "ar-AR":"?????? ??????????????"
}

Nested Schema : HierUnitNameTranslatedString

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "ar-AR":"??????????"
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top