Employees

This is the API Documentation for the /api/employees/ route.

Get ALL Employees

GET api/employees/

200: OK Employees[]

Responds with an Array of Employees

Get Employee

GET api/employees/:id

Path Parameters

Name	Type	Description
id*	String	The ID of the Employee

200: OK Employee

Returns an Employee object.

404: Not Found

Insert Employee

POST api/employees/

Request Body

Name	Type	Description
forename*	String	The First Name of the Employee
surname*	String	The Family Name of the Employee
department*	Department	The Department of the Employee
password*	String	The account password
confirmPassword*	String	The users confirmation of the account password

400: Bad Request

500: Internal Server Error

200: OK

Login as User

POST api/employees/login

Request Body

Name	Type	Description
email*	String	The e-mail for the User Account
password*	String	The plaintext password for the User Account

400: Bad Request

200: OK { email: string, password: string }

Encrypt Password

POST api/employees/generate-password

Encrypt a password using the API via BCrypt.

Request Body

Name	Type	Description
password*	String	The plaintext password for the User Account

400: Bad Request

200: OK { status: true, password: string }

Delete ALL Employees

DELETE api/employees/

200: OK

Delete Employee

DELETE api/employees/:id

Path Parameters

Name	Type	Description
id*	String	The ID of the Employee

200: OK

Edit Employee

PATCH api/employees/:id

Path Parameters

Name	Type	Description
id*	String	The ID of the Employee

Request Body

Name	Type	Description
forename*	String	The First Name of the Employee
surname*	String	The Family Name of the Employee
department*	Department	The Department of the Employee

200: OK