employees/{id}
Retrieve an employee by ID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
An Employee ID set by ECMS |
integer |
Required |
Body Parameters
None.
Response Information
Standard Responses
An employee
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Id of the employee set by ECMS |
integer |
None. |
| employeeId |
The alphanumeric identifier for the employee |
string |
None. |
| firstName |
The first name of the employee |
string |
None. |
| middleName |
The middle name of the employee |
string |
None. |
| lastName |
The last name of the employee |
string |
None. |
| phoneNumber | string |
None. |
|
| emailAddress | string |
None. |
|
| hireDate |
ISO-8601 format of: yyyy-mm-dd, such as 1989-05-22 or MMM-dd-yyyy (MAY-22-1989) |
string |
None. |
| terminationDate |
ISO-8601 format of: yyyy-mm-dd, such as 1989-05-22 or MMM-dd-yyyy (MAY-22-1989) |
string |
None. |
| company | string |
None. |
|
| notes | string |
None. |
|
| isTerminated | boolean |
None. |
|
| hasUserAccount | boolean |
None. |
|
| sites | Collection of EmployeeSiteDto |
None. |
|
| username | string |
None. |
|
| passwordResetUserId | integer |
None. |
|
| emergencyContactPhoneNumber |
Emergency Contact Phone Number |
string |
None. |
| emergencyContactName |
Emergency Contact Name |
string |
None. |
| links | Collection of LinkDto |
None. |
Error Responses
| HTTP Status Code | Error Message | Type | Additional Information |
|---|---|---|---|
| 404 - NotFound | No employee found |
None. |
None. |