{"message":"Welcome to the Clinic Connect API Guide. Here are the list of available endpoints","endpoints":[{"entity":"Clinics","sap":"/api/clinics","services":{"get":[{"endpoint":"/","description":"Returns all the clinics","examples":["https://clinic-connect-backend-0o05.onrender.com/api/clinics"]},{"endpoint":"/{id}","description":"Returns a specific clinic identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/clinics/1"]},{"endpoint":"/owner/{id}","description":"Returns all the clinics owned by a specific owner identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/clinics/owner/1"]}],"post":{"endpoint":"/","description":"Creates a new clinic"},"put":{"endpoint":"/{id}","description":"Updates a specific clinic identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific clinic identified by id"}}},{"entity":"Authentication","sap":"/api/auth/login","services":{"post":{"endpoint":"/","description":"This is the endpoint used to get the users login crediential's and login to the respective dashboard with a authentication token."}}},{"entity":"Register","sap":"/api/register","services":{"post":{"endpoint":"/","description":"Used to register a new patient to the system."}}},{"entity":"Users","sap":"/api/users","services":{"get":[{"endpoint":"/","description":"Returns all the users","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users"]},{"endpoint":"/{id}","description":"Returns a specific user identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/1"]},{"endpoint":"/patients","description":"Returns all the users who are patients","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/patients"]},{"endpoint":"/patients/{id}","description":"Returns the user who is a patient identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/patients/1003"]},{"endpoint":"/doctors","description":"Returns all the users who are doctors","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/doctors"]},{"endpoint":"/doctors/{id}","description":"Returns the user who is a doctor identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/doctors/1004"]},{"endpoint":"/doctors/search/?search=${searchInput}","description":"Returns the doctors that match the search query, the query can be a name, speciality or department","examples":["https://clinic-connect-backend-0o05.onrender.com/api/doctors/search/?search=John","https://clinic-connect-backend-0o05.onrender.com/api/doctors/search/?search=Cardiology"]}],"post":{"endpoint":"/","description":"Creates a new user"},"put":{"endpoint":"/{id}","description":"Updates a specific user identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific user identified by id"},"patch":{"endpoint":"/users/{id}","description":"Used to edit the User's Profile Image"}}},{"entity":"Patients","sap":"/api/users/patients","services":{"get":[{"endpoint":"/","description":"Returns all the patients","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/patients"]},{"endpoint":"/{id}","description":"Returns a specific patient identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/patients/1003"]},{"endpoint":"/user/{id}","description":"Returns the patient identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/patients/user/114"]}],"post":{"endpoint":"/","description":"Creates a new patient"},"put":{"endpoint":"/{id}","description":"Updates a specific patient identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific patient identified by id"}}},{"entity":"Doctors","sap":"/api/users/doctors","services":{"get":[{"endpoint":"/","description":"Returns all the Doctors","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/doctors"]},{"endpoint":"/{id}","description":"Returns a specific doctor identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/doctors/3"]},{"endpoint":"/user/{id}","description":"Returns the doctor identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/users/doctors/user/112"]}],"post":{"endpoint":"/","description":"Creates a new doctor"},"put":{"endpoint":"/{id}","description":"Updates a specific doctor identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific doctor identified by id"}}},{"entity":"Specialisations","sap":"/api/specialisations","services":{"get":[{"endpoint":"/","description":"Returns all the Specialisations","examples":["https://clinic-connect-backend-0o05.onrender.com/api/specialisations"]},{"endpoint":"/{id}","description":"Returns a specific specialisation identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/specialisations/3"]}],"post":{"endpoint":"/","description":"Creates a new specialisation"},"put":{"endpoint":"/{id}","description":"Updates a specific specialisation identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific specialisation identified by id"}}},{"entity":"Departments","sap":"/api/departments","services":{"get":[{"endpoint":"/","description":"Returns all the Departments","examples":["https://clinic-connect-backend-0o05.onrender.com/api/departments"]},{"endpoint":"/{id}","description":"Returns a specific department identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/departments/3"]}],"post":{"endpoint":"/","description":"Creates a new department"},"put":{"endpoint":"/{id}","description":"Updates a specific department identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific department identified by id"}}},{"entity":"Clinic Staff","sap":"/api/clinicStaff","services":{"get":[{"endpoint":"/","description":"Returns all the staff who belongs to any clinic","examples":["https://clinic-connect-backend-0o05.onrender.com/api/clinicStaff"]},{"endpoint":"/{id}","description":"Returns a specific staff member from a clinic identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/clinicStaff/3"]}],"post":{"endpoint":"/","description":"Assigns a staff member to clinic"},"put":{"endpoint":"/{id}","description":"Updates a specific staff member identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific staff member identified by id"}}},{"entity":"Schedules","sap":"/api/schedules","services":{"get":[{"endpoint":"/","description":"Returns all the schedules","examples":["https://clinic-connect-backend-0o05.onrender.com/api/schedules"]},{"endpoint":"/{id}","description":"Returns a specific schedule identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/schedules/3"]},{"endpoint":"/staff/{id}","description":"Returns a specific schedule identified by staff id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/schedules/staff/3"]},{"endpoint":"/doctor/{id}","description":"Returns a specific schedule identified by doctor id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/schedules/doctor/3"]}],"post":{"endpoint":"/","description":"Assigns a schedule to a doctor"},"put":{"endpoint":"/{id}","description":"Updates a specific schedule of a doctor identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific schedule identified by id"}}},{"entity":"Appointments","sap":"/api/appointments","services":{"get":[{"endpoint":"/","description":"Returns all the appointments","examples":["https://clinic-connect-backend-0o05.onrender.com/api/appointments"]},{"endpoint":"/{id}","description":"Returns a specific appointment identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/appointments/3"]},{"endpoint":"/search?doctorID={doctorID}&date={date}","description":"Returns a specific appointment identified by query parameters doctorID and date","examples":["https://clinic-connect-backend-0o05.onrender.com/api/appointments/search?doctorID={doctorID}&date={date}"]},{"endpoint":"/patient/{patientID}","description":"Returns all the appointments of a patient identified by patient id, the completed and cancelled appointments will also be included","examples":["https://clinic-connect-backend-0o05.onrender.com/api/appointments/patient/1002"]},{"endpoint":"/doctor/{doctorID}","description":"Returns all the appointments of a doctor identified by doctor id, the completed and cancelled appointments will also be included","examples":["https://clinic-connect-backend-0o05.onrender.com/api/appointments/doctor/1"]},{"endpoint":"/patient/upcoming/{patientID}","description":"Returns all the upcoming appointments of a patient, the completed and cancelled appointments will not be included, identified by patient id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/appointments/patient/upcoming/1002"]},{"endpoint":"/doctor/upcoming/{doctorID}","description":"Returns all the upcoming appointments of a doctor, the completed and cancelled appointments will not be included, identified by doctor id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/appointments/doctor/upcoming/1"]}],"post":{"endpoint":"/","description":"Assigns an appointment to a patient with a doctor"},"put":{"endpoint":"/{id}","description":"Updates a specific appointment to a patient with a doctor identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific appointment identified by id"}}},{"entity":"Medical Reports","sap":"/api/medicalReports","services":{"get":[{"endpoint":"/","description":"Returns all the medical reports of the patients","examples":["https://clinic-connect-backend-0o05.onrender.com/api/medicalReports"]},{"endpoint":"/{id}","description":"Returns a specific medical report identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/medicalReports/2"]},{"endpoint":"/patient/{patientID}","description":"Returns medical reports of a specific patient","examples":["https://clinic-connect-backend-0o05.onrender.com/api/medicalReports/patient/1002"]}],"post":{"endpoint":"/","description":"Assigns a medical report to a patient from a doctor"},"put":{"endpoint":"/{id}","description":"Updates a specific medical report for a patient from a doctor identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific medical report identified by id from a doctor"}}},{"entity":"Test Results","sap":"/api/testResults","services":{"get":[{"endpoint":"/","description":"Returns all the Test results","examples":["https://clinic-connect-backend-0o05.onrender.com/api/testResults"]},{"endpoint":"/{id}","description":"Returns a specific test result identified by id","examples":["https://clinic-connect-backend-0o05.onrender.com/api/testResults/2"]},{"endpoint":"/medicalReport/{medicalReportID}","description":"Returns all the Test results of a specific medical report","examples":["https://clinic-connect-backend-0o05.onrender.com/api/testResults/medicalReport/2"]}],"post":{"endpoint":"/","description":"Assigns a test result to a medical report "},"put":{"endpoint":"/{id}","description":"Updates a specific test result for a medical report identified by id"},"delete":{"endpoint":"/{id}","description":"Deletes a specific test result identified by id from a medical report"}}}]}