| Property | Required | Details | Location |
|---|---|---|---|
page |
Index returns 100 records per request. Defaults to 1. Must be a Integer |
URL |
GET /hr_api/v1/employees
200
{
"employees": [
{
"uuid": "737c1dd0-4134-4743-849d-8e38d0e11644",
"employee_id_string": "123456"
},
{
"uuid": "7b517859-c1c9-48cb-a508-325fa8a1b6b5",
"employee_id_string": "234234"
},
{
"uuid": "9d3f1d9a-ed0c-4cf0-80a4-d6b703b58231",
"employee_id_string": "56232342"
},
{
"uuid": "8a161061-ba23-4f1c-99ba-78b1578465ce",
"employee_id_string": "345234523"
},
{
"uuid": "625a97d6-efda-4aba-93a2-25d35ea7ce7b",
"employee_id_string": "benpearson_demo"
},
{
"uuid": "9436eb98-7998-40b8-9ddd-481129a05ebf",
"employee_id_string": "Jonny NoDetails"
},
{
"uuid": "d6084128-82be-4814-98f5-9107faaa3636",
"employee_id_string": "id string"
},
{
"uuid": "d3ec6d11-2f78-4490-ad7d-0b7911814504",
"employee_id_string": "id string2"
},
{
"uuid": "22620604-eaae-4564-b11d-230671930dbe",
"employee_id_string": "updated example employee id string"
},
{
"uuid": "3809606b-0944-457d-8a06-f71a7a0e79da",
"employee_id_string": "a"
},
{
"uuid": "2cd9b201-9f7c-4f3e-8de8-94d9d7ac2804",
"employee_id_string": "123"
}
]
}
| Property | Required | Details | Location |
|---|---|---|---|
uuid |
Must be a String |
URL |
GET /hr_api/v1/employees/:uuid
200
{
"employee": {
"employee_id_string": "123456",
"former_employee_id_string": null,
"uuid": "737c1dd0-4134-4743-849d-8e38d0e11644",
"is_employed": null,
"start_date": null,
"end_date": null,
"employments": [
{
"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": {
"employee_id_string": "123456",
"former_employee_id_string": null,
"uuid": "737c1dd0-4134-4743-849d-8e38d0e11644",
"is_employed": null,
"start_date": null,
"end_date": null
},
"termination_reason": {
"keyword_type": "ReasonForLeaving",
"keyword_id": null,
"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"
}
}
],
"person_info": {
"date_of_birth": "1976-01-05T00: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,
"employee": {
"employee_id_string": "123456",
"former_employee_id_string": null,
"uuid": "737c1dd0-4134-4743-849d-8e38d0e11644",
"is_employed": null,
"start_date": null,
"end_date": null
},
"person": {
"uuid": "20317796-8abd-4f89-97bb-2b378e7c4ec4",
"status": "active",
"formatted_name": "Michael Hefferan",
"given_name": "Michael",
"family_name": "Hefferan",
"form_of_address": "Mr",
"middle_name": null,
"preferred_name": null,
"person_info": {
"date_of_birth": "1976-01-05T00: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,
"employee": {
"employee_id_string": "123456",
"former_employee_id_string": null,
"uuid": "737c1dd0-4134-4743-849d-8e38d0e11644",
"is_employed": null,
"start_date": null,
"end_date": null
}
}
}
}
}
}
| 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': 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': 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': 'No' '1': 'Yes' |
JSON | |
is_disabled |
Must be one of: '0': 'No' '1': 'Yes' |
JSON | |
is_tobacco_user |
Must be one of: '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: |
JSON |
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
}
}
| Property | Required | Details | Location |
|---|---|---|---|
uuid |
Must be a String |
URL | |
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': 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': 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': 'No' '1': 'Yes' |
JSON | |
is_disabled |
Must be one of: '0': 'No' '1': 'Yes' |
JSON | |
is_tobacco_user |
Must be one of: '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: |
JSON |
PUT /hr_api/v1/employees/:uuid
{
"employee_id_string": "123456"
}
200
{
"message": "Employee updated successfully",
"employee": {
"employee_id_string": "updated example employee id string",
"former_employee_id_string": null,
"uuid": "737c1dd0-4134-4743-849d-8e38d0e11644",
"is_employed": null,
"start_date": null,
"end_date": null,
"date_of_birth": "1976-01-05T00: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": "Mr",
"middle_name": null,
"preferred_name": null
}
}
| Property | Required | Details | Location |
|---|---|---|---|
uuid |
Must be a String |
URL |
DELETE /hr_api/v1/employees/:uuid
{}
200
{
"message": "Employee cannot be deleted because it is referenced by other data"
}