POST /hr_api/v1/employees

Creates a new Employee

Params

Property Required Details Location

employee_id_string

Must be a String

 JSON

given_name

Must be a String

 JSON

middle_name

Must be a String

 JSON

family_name

Must be a String

 JSON

preferred_name

Must be a String

 JSON

date_of_birth

Must be a Date

 JSON

is_employed

The Employee's current employment status.

Must be one of: 0, 1.

'0': Not employed
'1': Employed
JSON

start_date

Must be a Date

 JSON

end_date

Must be a Date

 JSON

gender_code

Must be one of: 0, 1, 2, 9.

'0': None
'1': Male
'2': Female
'9': None specified
JSON

primary_language

Must be a String

 JSON

marital_status

Must be a String

Examples:

- Domestic Partner
- Divorced
- Legally Separated
- Married
- Separated
- Unmarried
- Unreported
- Widowed
JSON

form_of_address

Salutation.

Must be a String

Examples:

- Mr
- Mrs
- Miss
- Dr
JSON

former_employee_id_string

To link to a previous Employee record when an existing Employee moves to a new role.

Must be a String

 JSON

date_of_death

Must be a Date

 JSON

is_veteran

Must be one of: 0, 1.

'0': 'No'
'1': 'Yes'
JSON

is_disabled

Must be one of: 0, 1.

'0': 'No'
'1': 'Yes'
JSON

is_tobacco_user

Must be one of: 0, 1.

'0': 'No'
'1': 'Yes'
JSON

race

Must be a String

 JSON

ethnicity

Must be a String

 JSON

religion

Must be a String

 JSON

mobility_comments

To indicate whether the Employee is willing and able to relocate.

Must be a String

 JSON

status

Will default to 'active' if not set, and will automatically update based on other conditions unless overridden.

Must be one of: new, active, inactive.

 JSON

Examples

POST /hr_api/v1/employees
{
  "employee_id_string": "123456",
  "given_name": "John",
  "family_name": "Smith",
  "date_of_birth": "1900-01-01"
}
201
{
  "message": "Employee created successfully",
  "employee": {
    "employee_id_string": "test",
    "former_employee_id_string": null,
    "uuid": "737c1dd0-4134-4743-849d-8e38d0e11644",
    "is_employed": null,
    "start_date": null,
    "end_date": null,
    "date_of_birth": "1900-01-01T00:00:00.000+00:00",
    "date_of_death": null,
    "gender_code": 1,
    "is_veteran": null,
    "is_disabled": null,
    "is_tobacco_user": null,
    "race": null,
    "ethnicity": null,
    "primary_language": null,
    "religion": null,
    "marital_status": null,
    "mobility_keyword_id": null,
    "mobility_comments": null,
    "person_info": {
      "uuid": "20317796-8abd-4f89-97bb-2b378e7c4ec4"
    },
    "status": "active",
    "formatted_name": "John Smith",
    "given_name": "John",
    "family_name": "Smith",
    "form_of_address": null,
    "middle_name": null,
    "preferred_name": null
  }
}