API Documentation

Getting Started
Endpoint URL https://bbb.eddukalyo.com/pages/endpoint.php
Request Method: GET
Example, Get current Server Time https://bbb.eddukalyo.com/pages/endpoint.php?api_token=access_token&getTime=true
Request Body `{ api_token:"your api access token value", getTime: true }`
Response (JSON) `{ server_time : YYYY-MM-DD HH:MM:SS }`

Reference

Employees List
Request Parameters	Required
`viewusers=true`	YES

Response	Type
`[ { "name":"Employee Name, "gender":"Gender", "email":"email", "telephone":"phone_number", "role":"user role", "id":"user id", "status":"status", "image":"profile photo link", "department_id":"department Id", "department_name":"Department Name" },... ]`	Array

Employees Details
Request Parameters	Required
`view_employee_details={employee_id}`	YES

Response Type

{ bank_acno: "Bank A/C NO" bank_name: "Bank Name" department: "Department Id" district: "District" dob: "Date of Birth" email: "employee email" gender: "Gender" id: "Employee Id" image: "profile photo link" kin_lc: "Emergency Contact Person LC1" kin_name: "Emergency Contact Person Name" kin_relationship: "Emergency Contact Person Relationship with employee" kin_tel: "Emergency Contact Person Telephone" kin_village: "Emergency Contact Person Village" lc: "Employee Lc" marital_status: "Marital Status" name: "Employee Full names" nationality: "Employee Nationality" nin: "NIN" nssf_no: "NSSF No." othernames: "Employee Other names" parish: "Parish" pob_county: "Place of Birth County" pob_district: "Place of Birth District" pob_village: "Place of Birth Village" projects: "[{Projects List},]" residence: "Employee Village of Residence" role: "Employee Role" sub_county: "Employee Sub County of Residence" telephone: "Employee Telephone Number" tin: "Employee Tin No." title: "Employee Title" village: "Employee Village of Residence" } Json Object

Departments
Request Parameters	Required
`view_departments=true`	YES

Response	Type
`[{name: "Department Name", description: "Description", id: "department id"},...]`	Array

Projects
Request Parameters	Required
`view_projects=true`	YES

Response	Type
`[{name: "Project Name", description: "Project Description", department: "Department Id",department_name:"Department Name",id:"Project Id"},...]`	Array

Employee Schedules
Request Parameters	Required
`{ date_from: "YYYY-MM-DD", date_to: "YYYY-MM-DD", report_type: "schedules", employee: "Employee Id" }`	YES

Response	Type
`{"data":[{"to_date":"YYYY-MM-DD","completed":"NO","activity":"Activity Name","project":"Project Name","from_date":"YYYY-MM-DD"},...],"title":"Title"}`	JSON

Attendance Schedules
Request Parameters	Required
`{ date_from: "YYYY-MM-DD", date_to: "YYYY-MM-DD", report_type: "attendance", employee: "Employee Id" }`	YES

Response	Type
`{"data":[{"date":"YYYY-MM-DD","clock_in":"HH:MM","clock_out":"HH:MM","late":"Time","absent":"NO/YES","over_time":"Overtime","work_time":"Worked time"},...],"title":"Title"}`	JSON

Work Records
Request Parameters	Required
`{ date_from: "YYYY-MM-DD", date_to: "YYYY-MM-DD", report_type: "work_records", employee: "Employee Id" }`	YES

Response	Type
`{"data":[{date: "YYYY-MM-DD, hours: "Hours", activity: "Activity Name", project: "Project Name"},...],"title":"Title"}`	JSON

Work Plan
Request Parameters	Required
`{ quarte: "Quarter of the YEAR", year: "YYYY", report_type: "workplan_graph", }`	YES

Response	Type
`{"total_activities":"{"BAMA Program":6,"FRE02":2}", "total_completed":"{"BAMA Program":2,"FRE02":1}", "total_pending":"{"BAMA Program":3}", "total_ongoing":"{"BAMA Program":1,"FRE02":1}", "projects":["BAMA Program","FRE02"], "overall":{"completed":3,"pending":3,"ongoing":2,"overall":8}, "app":"BAMA FOUNDATION"}`	JSON