https://github.com/remiljw/telemedicine
API built with DRF to book hospital appointments.
https://github.com/remiljw/telemedicine
api django django-rest-framework drf unit-test
Last synced: 3 months ago
JSON representation
API built with DRF to book hospital appointments.
- Host: GitHub
- URL: https://github.com/remiljw/telemedicine
- Owner: remiljw
- Created: 2021-01-26T15:25:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-10T15:34:41.000Z (over 3 years ago)
- Last Synced: 2025-01-20T12:23:37.158Z (5 months ago)
- Topics: api, django, django-rest-framework, drf, unit-test
- Language: JavaScript
- Homepage:
- Size: 1.19 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# TeleMedicine API
[](https://circleci.com/gh/remiljw/telemedicine)
[](https://github.com/remiljw/telemedicine/actions)
API built with DRF for a telemedicine app to book hospital appointments.
## Endpoints
### https://telemed-api.herokuapp.com/api/patient-signup/
- Anyone can access this endpoint, it is meant to register new patients into the system.
```python
payload = {
"email" : "[email protected]" ,
"password" : "iamapatient",
"patient" : {
"first_name" : "John",
"last_name" : "Doe",
"date_of_birth" : "1999-01-24", #Date_of_birth must be in 'YYYY-MM-DD' format.
"address": "17, Highway Street, Lagos."
}
}
```
### https://telemed-api.herokuapp.com/api/signin/
- All users sign in here and get JWT tokens, which are used to access the remaining endpoints.
```
payload = {
'email' : '[email protected]'
'password' : 'iamapatient'
}
response = {
'token' : 'JWT TOKEN'
}
```
### https://telemed-api.herokuapp.com/api/add-doctor/
- Only Admin Users have access to this endpoint. They add doctors to the system. Token is needed for authentication, which is gotten from the `signin/` endpoint.
```
payload = {
'email' : '[email protected]' ,
'password' : 'iamadoctor',
'doctor' : {
'first_name' : 'Doctor'
'last_name' : 'Who'
'date_of_birth' : '1999-01-24' #Date_of_birth must be in 'YYYY-MM-DD' format.
'address': '17, Highway Street, Lagos.'
}
}
```
### https://telemed-api.herokuapp.com/api/doc-calendar/
- Only doctors have access to this endpoint, they create their availability here. Token is needed for authentication, which is gotten from the `signin/` endpoint.
```
payload = {
'date': '2020-01-30' #date must be in 'YYYY-MM-DD' format.
}
```
### https://telemed-api.herokuapp.com/api/book-appointment/
- Can be accessed by all patients, to book appointments based on their doctor of choice availability. Date and Doctor fields accepts only integers which are the id of the doctor and the available date.
```
payload = {
'doctor' : 1, #doctor_id
'date' : 1, #date_id
'reason_for_visit' : Sore Throat'
'time' : 1 # options ranges from 1 - 5 as they stand for key for the value of time. ('1', '09:00 – 10:00'),
#('2', '10:00 – 11:00'),
# ('3', '11:00 – 12:00'),
#('4', '12:00 – 13:00'),
#('5', '13:00 – 14:00'),
}
```
## Authentication
- All end points need authentication to access except `signin/` and `patient-signup/`.
- Get your token from the `signin/` endpoint and add it to the request headers.
```
(Authorization : 'Bearer ' + yourtoken)
```
- You are good to go. 👍🏾
## Credentials
- Here is the credential for the admin
```
email : [email protected]
password: bond007
```
## Miscellaneous
You can also test via the browsable apis by clicking on the links, and login where necessary.