Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 7

Attendance and kind notes APIS

Attendance API’S
Attendance API can be used to capture the check-in and check-out entries of an individual employee.
The system will mark the attendance of individual employees.

Check-In
Description:

Check in API is used when an employee needs to checked in to the system. In the API URL,
organization_id will be static that is 4 and in emp_code, code of each specific employee is passed. For
check-in API POST method is used.

Request URL:
http://34.247.6.99:8000/api/organization/4/attendance/check_in/<emp_code>/

Method:
POST

Response body:
In response body of check_in API following attributes appear:

Id, employee_name, employee_code, date, check_in, is_check_in

Messages:
Code Message

200 Check in successfully

400 Employee does not exist
Screen Shot:

Check-Out
Description:

Check out API is used when an employee needs to checked out from the system. In the API URL
organization_id will be static that is 4 and in emp_code, code of each employee is passed. For check-out
API PATCH method is used.

Request URL:
http://34.247.6.99:8000 /api/organization/4/attendance/check_out/<emp_code>/

Method:
PATCH

Response body:
In response body of check_out API following attributes appear:

Id, employee_name, employee_code, date, check_out,is_check_out

Messages:
Code Message

200 Check out successfully

400 Employee does not exist
Screen Shot:

Get attendance of specific employee


Description:

Get API is used to list the attendance of a specific employee up to 7 days. In the API URL organization_id
will be static that is 4 and in emp_code, code of each employee is passed. For getting list of attendance
of a specific employee GET method is used.

Request URL:
http://34.247.6.99:8000 /api/organization/4/attendance/list/<emp_code>/

Method:
GET

Response body:
In response body of list attendence API following attributes appear:

Id, employee_name, employee_code, date, is_check_in, check_in, check_out,is_check_out

Messages:
Code Message

200 Success
Screen Shot:

Kind Notes APIS


Kind notes APIS are used to add notes for an employee. Notes are added by the employees of that
organization. There is also an option to update and delete a note.

Add note:
Description:

The following API is used to add a kind note. In the API URL organization_id will be static that is 4.

Request URL:
http://34.247.6.99:8000/api/organization/4/kind/notes/

Method:
POST

Request parameters:
sender Specify the sender id.
receiver Specify the receiver id.
note Specify the note that sender is sending.
Response body:
In response body of list attendence API following attributes appear:

Id, sender, sender_name, reciever, receiver_name, note

Messages:
Code Message

200 Success

400 Validation error.

Screen Shot:

View all kind notes


Description:

Get API is used to list all the kind notes for that organization.

Request URL:
http://34.247.6.99:8000/api/organization/4/kind/notes/

Method:
GET

Response body:
In response body of list attendence API following attributes appear:
Id, sender, sender_name, reciever, receiver_name, note

Messages:
Code Message

200 Success

Screen Shot:

List Kind notes for specific employee


Description:

Get API is used to list the kind notes of a specific employee. In the API URL organization_id will be static
that is 4 and in emp_code, code of specific employee is passed.

Request URL:
http://34.247.6.99:8000/api/organization/4/kind/notes/employee/<emp_code>/

Method:
GET

Response body:
In response body of list attendence API following attributes appear:

Id, sender, sender_name, reciever, receiver_name, note

Messages:
Code Message

200 Success

400 This employee has no kind notes
Screen Shot:

You might also like