employees
Adds a single employee.
Request Information
URI Parameters
None.
Body Parameters
An employee to create
AddEmployeeDto| Name | Description | Type | Additional information |
|---|---|---|---|
| emailAddress | string |
None. |
|
| employeeId |
The alphanumeric identifier for the employee |
string |
None. |
| firstName |
The first name of the employee |
string |
Required |
| middleName |
The middle name of the employee |
string |
None. |
| lastName |
The last name of the employee |
string |
Required |
| phoneNumber | 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 |
Date of termination. Leave blank for current employees. If this employee has a user account, they will no longer be able to log in after this date. ISO-8601 format of: yyyy-mm-dd, such as 1989-05-22 or MMM-dd-yyyy (MAY-22-1989) |
string |
None. |
| company |
Company name the employee belongs to |
string |
None. |
| notes | string |
None. |
|
| sites |
All site memberships. Any current memberships that are not included here will be removed. |
Collection of EmployeeSiteDto |
None. |
| isSingleSignOnUser | boolean |
None. |
|
| username |
Employee's Username |
string |
None. |
| resetPasswordPermissionFrom |
Employee ID of the Password Reset User |
integer |
None. |
| emergencyContactPhoneNumber |
Employee's Emergency Contact Phone Number |
string |
None. |
| emergencyContactName |
Emergency Contact Name |
string |
None. |
Response Information
Standard Responses
None.
Error Responses
| HTTP Status Code | Error Message | Type | Additional Information |
|---|