API design

Here's a breakdown of the essential REST

API for our Employee Swap System.

User service:

PUT /auth/login - authenticate a user

PUT /auth/logout - log out user

POST /auth/register - register new user:

{ "name": "name1"

"email":....

"phone": ...

"employe_id":

"position":

"department":

"manager_id"

}

Employee shift matching service:

PUT /shift_matching/v1/swap/{employee_id1}/{shift_id1}/swap/{employee_id2}/{shift_id2} - try to swap the shift_id1 of the employee_id1 with shift_id2 of employee_id2:

Return :

{ "swap_id"....

"status": IN_PROGRESS,APPROVED_BY_MANAGER,APPROVED_BY_OTHER_EMPLOYEE,CANCELED

"createdAt": ....

}

GET /shift_matching/v1/swap/{employee_id}/status/{shift_id} - return the swap attempt status:

{ "swap_id"....

"status": IN_PROGRESS,APPROVED_BY_MANAGER,APPROVED_BY_EMPLOYEE,CANCELED

"createdAt": ....

}

GET /shift_matching/v1/shift/{employee_id}

return the available shifts for an employee

{[.

'shift_id':

'employee_id':

'start_time':

'end_time':

'last_swap_date':

]}

PUT /shift_matching/v1/swap/{employee_id}/approve/{shift_id} - an employee approves the suggested shift.

PUT /shift_matching/swap/manager/{manager_id}/approve/{shift_id} - a manager approves the suggested shift if both employees agree.

Employee Shift service:

GET /employee_shift/v1/shift/{employee_id}/shifts - get the list of the shifts scheduled by the employee_id:

{ "employee_id":...

"shifts":[

{ "shift_id":....

"startFrom":

"endTo":

'status':

'last_swap_date'

},

....

]

POST /employee_shift/v1/shift/{employee_id}

Persist the new shift for an employee.

body:

{ 'shift_id'

'employee_id'

'start_date':

'end_date':

'status':

'last_swap_date':

}

PUT /employee_shift/v1/shift/{employee_id}

Update the shift information for an employee.

Submissions

Displaying Solutions with Scores Ranging from 1 to 10

Submissions

Displaying Solutions with Scores Ranging from 1 to 10