Employments

Supported Formats: json
View

GET /hr_api/v1/employments

Returns a list of Employments

Params

Property Required Details Location

page

Index returns 100 records per request. Defaults to 1.

Must be a Integer

 URL

Examples

GET /hr_api/v1/employments
200
{
  "employments": [
    {
      "uuid": "853d0df6-971a-4551-a834-b61583a935b3"
    },
    {
      "uuid": "aa8792e3-f9fd-428e-82af-117f34aed8de"
    },
    {
      "uuid": "d724cd8d-afb2-403f-bea4-cccab7207f5f"
    }
  ]
}
View

GET /hr_api/v1/employments/:uuid

Return details of an existing Employment

Params

Property Required Details Location

uuid

Must be a String

 URL

Examples

GET /hr_api/v1/employments/:uuid
200
{
  "employment": {
    "uuid": "853d0df6-971a-4551-a834-b61583a935b3",
    "hire_date": "2016-11-03T00:00:00.000+00:00",
    "original_hire_date": null,
    "adjusted_hire_date": null,
    "is_on_leave": null,
    "is_terminated": null,
    "termination_is_voluntary": null,
    "termination_reason_comments": null,
    "termination_date": null,
    "last_date_worked": null,
    "last_date_paid": null,
    "employee": {
      "employee_id_string": "123",
      "former_employee_id_string": null,
      "uuid": "2cd9b201-9f7c-4f3e-8de8-94d9d7ac2804",
      "is_employed": null,
      "start_date": null,
      "end_date": null
    }
  }
}
View

POST /hr_api/v1/employments

Creates a new Employment

Params

Property Required Details Location

employee_uuid

Must be a String

 JSON

hire_date

Must be a Date

 JSON

original_hire_date

Must be a Date

 JSON

adjusted_hire_date

Must be a Date

 JSON

termination_date

Must be a Date

 JSON

last_date_worked

Must be a Date

 JSON

last_date_paid

Must be a Date

 JSON

is_on_leave

Must be one of: 0, 1.

'0': Not on leave
'1': On leave
JSON

is_terminated

Must be one of: 0, 1.

'0': Not terminated
'1': Terminated
JSON

termination_is_voluntary

Must be one of: 0, 1.

'0': Not voluntary
'1': Voluntary
JSON

termination_reason_uuid

Obtained from a separate TerminationReason request

Must be a String

 JSON

termination_reason_comments

Must be a String

 JSON

Examples

POST /hr_api/v1/employments
{
  "employee_uuid": "2cd9b201-9f7c-4f3e-8de8-94d9d7ac2804",
  "hire_date": "2016-11-03T00:00:00.000+00:00"
}
201
{
  "employment": {
    "uuid": "19f726a7-2365-41b0-9552-ebc1bab5de48",
    "hire_date": "2016-01-01T00:00:00.000+00:00",
    "original_hire_date": "2016-01-01T00:00:00.000+00:00",
    "adjusted_hire_date": "2016-01-01T00:00:00.000+00:00",
    "is_on_leave": false,
    "is_terminated": true,
    "termination_is_voluntary": true,
    "termination_reason_comments": null,
    "termination_date": "2016-02-02T00:00:00.000+00:00",
    "last_date_worked": "2016-02-02T00:00:00.000+00:00",
    "last_date_paid": null,
    "employee_id_string": "123456",
    "employee": {
      "uuid": "737c1dd0-4134-4743-849d-8e38d0e11644"
    },
    "keyword_type": "ReasonForLeaving",
    "keyword_id": null,
    "termination_reason": {
      "uuid": "5e4405f6-532c-46be-a72a-8b372803525b"
    },
    "category_code": "reaon_for_leaving",
    "comments": "<p>comment for test reason for leaving</p>",
    "sort": 100,
    "category_status": "active",
    "category_description": "test reason for leaving keyword"
  }
}
View

PATCH | PUT /hr_api/v1/employments/:uuid

Updates an existing Employment

Params

Property Required Details Location

uuid

Must be a String

 URL

employee_uuid

Must be a String

 JSON

hire_date

Must be a Date

 JSON

original_hire_date

Must be a Date

 JSON

adjusted_hire_date

Must be a Date

 JSON

termination_date

Must be a Date

 JSON

last_date_worked

Must be a Date

 JSON

last_date_paid

Must be a Date

 JSON

is_on_leave

Must be one of: 0, 1.

'0': Not on leave
'1': On leave
JSON

is_terminated

Must be one of: 0, 1.

'0': Not terminated
'1': Terminated
JSON

termination_is_voluntary

Must be one of: 0, 1.

'0': Not voluntary
'1': Voluntary
JSON

termination_reason_uuid

Obtained from a separate TerminationReason request

Must be a String

 JSON

termination_reason_comments

Must be a String

 JSON

Examples

PUT /hr_api/v1/employments/:uuid
{
  "termination_reason_comments": null
}
200
{
  "message": "Employment updated successfully",
  "employment": {
    "uuid": "d724cd8d-afb2-403f-bea4-cccab7207f5f",
    "hire_date": "2016-01-01T00:00:00.000+00:00",
    "original_hire_date": "2016-01-01T00:00:00.000+00:00",
    "adjusted_hire_date": "2016-01-01T00:00:00.000+00:00",
    "is_on_leave": false,
    "is_terminated": true,
    "termination_is_voluntary": true,
    "termination_reason_comments": "TEST",
    "termination_date": "2016-02-02T00:00:00.000+00:00",
    "last_date_worked": "2016-02-02T00:00:00.000+00:00",
    "last_date_paid": null,
    "employee_id_string": "123456",
    "employee": {
      "uuid": "737c1dd0-4134-4743-849d-8e38d0e11644"
    },
    "keyword_type": "ReasonForLeaving",
    "keyword_id": null,
    "termination_reason": {
      "uuid": "5e4405f6-532c-46be-a72a-8b372803525b"
    },
    "category_code": "reaon_for_leaving",
    "comments": "<p>comment for test reason for leaving</p>",
    "sort": 100,
    "category_status": "active",
    "category_description": "test reason for leaving keyword"
  }
}
View

DELETE /hr_api/v1/employments/:uuid

Deletes an existing Employment

Params

Property Required Details Location

uuid

Must be a String

 URL

Examples

DELETE /hr_api/v1/employments/:uuid
{}
200
{
  "message": "Employment  deleted"
}