by: Isaac Sarte & Argie Barcena
Ruby 3.0.2
Rails 6.1.5
NodeJS 12.18.3
Yarn 1.22.4
https://jnceclinicapi.herokuapp.com
===============================
HTTP Method: POST
URL: {{url}}/admins/
{
"email": "admin1@example.com",
"password": "123456"
}
Name |
Description |
Required |
email |
Admin email |
Yes |
password |
Admin password |
Yes |
HTTP Method: POST
URL: {{url}}/admins/sign_in
{
"email": "admin1@example.com",
"password": "123456"
}
Name |
Description |
Required |
email |
Admin email |
Yes |
password |
Admin password |
Yes |
HTTP Method: DELETE
URL: {{url}}/admins/sign_out
{
"email": "admin1@example.com",
"password": "123456"
}
Name |
Description |
Required |
email |
Admin email |
Yes |
password |
Admin password |
Yes |
Headers
Name |
Required |
authorization token |
Yes |
Note: Feedback is for public users.
Admin Retrieve All Feedbacks
HTTP Method: GET
URL: {{url}}/api/v1/users/
Headers
Name |
Required |
authorization token |
Yes |
HTTP Method: GET
URL: {{url}}/api/v1/users/{{user_id}}
Headers
Name |
Required |
authorization token |
Yes |
Admin Retrieve All Appointments
HTTP Method: GET
URL: {{url}}/api/v1/appointments
Headers
Name |
Required |
authorization token |
Yes |
HTTP Method: GET
URL: {{url}}/api/v1/appointments/{{id}}
Headers
Name |
Required |
authorization token |
Yes |
Admin Change Appointment Status
HTTP Method: PUT
URL: {{url}}/api/v1/appointments/{{id}}
Name |
Description |
Required |
status |
Appointment status |
Yes |
Headers
Name |
Required |
authorization token |
Yes |
HTTP Method: GET
URL: {{url}}/api/v1/logs
Headers
Name |
Required |
authorization token |
Yes |
HTTP Method: GET
URL: {{url}}/api/v1/logs/{{id}}
Headers
Name |
Required |
authorization token |
Yes |
HTTP Method: POST
URL: {{url}}/api/v1/logs
{
"appointment_id": 1
"admin_id": 1
}
Name |
Description |
Required |
appointment_id |
Appointment id |
Yes |
admin_id |
Admin id |
Yes |
Headers
Name |
Required |
authorization token |
Yes |
===============================
HTTP Method: GET
URL: {{url}}/api/v1/services
===============================
HTTP Method: POST
URL: {{url}}/api/v1/users
{
"fullname": "test user"
"email": "testuser@example.com",
"phone": 01212312312,
"message": "test message feedback"
}
Name |
Description |
Required |
fullname |
User fullname |
Yes |
email |
User email |
Yes |
phone |
User phone |
Yes |
message |
User message |
Yes |
===============================
Note: Before booking appoinment, see this link for google oAuth endpoints:
https://github.com/Zhi0105/jnce-calendar-api
After connecting google oAuth, continue to Book Appointment Feature below.
HTTP Method: POST
URL: {{url}}/api/v1/appointments
{
"service_id": 1,
"status": "pending",
"fullname": "test fullname",
"location": "Subd., City, PH",
"start_datetime": Date.today,
"end_datetime": Date.today,
"title": "service title",
"email": "appointment@email.com"
}
Name |
Description |
Required |
service_id |
Service id |
Yes |
status |
Appointment initial status |
Yes |
fullname |
User fullname |
Yes |
location |
Medical Clinic's location not User's |
Yes |
start_datetime |
Appointment start date time |
Yes |
end_datetime |
Appointment end date time |
Yes |
title |
Service title |
Yes |
email |
User email |
Yes |
===============================