Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aabduvak/hospital-api

Hospital API is a cutting-edge project that revolutionizes healthcare communication by offering patients the ability to connect with their doctors at their convenience. With this api, patients can chat with their doctors through the platform, make appointments, and locate nearby hospitals all in one place.
https://github.com/aabduvak/hospital-api

api django django-rest-framework google-cloud

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/aabduvak/hospital-api
Owner: aabduvak
License: gpl-3.0
Created: 2023-02-14T19:58:35.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-05-04T03:13:55.000Z (9 months ago)
Last Synced: 2024-11-10T22:08:04.704Z (3 months ago)
Topics: api, django, django-rest-framework, google-cloud
Language: JavaScript
Homepage:
Size: 1.01 MB
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 📝 API Documentation

**Hospital API** is a cutting-edge project that revolutionizes healthcare communication by offering patients the ability to connect with their doctors at their convenience. With Ebebul, patients can chat with their doctors through the platform, make appointments, and locate nearby hospitals all in one place.

The platform offers a user-friendly interface that simplifies the process of scheduling appointments. Patients can search for doctors by specialty, location, and availability, making it easy to find a doctor that meets their specific needs. The platform also provides access to doctor profiles, where patients can view their credentials, specialties, and areas of expertise.

**Hospital API**'s chat feature allows patients to communicate directly with their doctors, eliminating the need for phone calls or emails. Patients can ask questions, receive advice, and discuss their health concerns in a secure, private environment. This feature allows for better communication and understanding between patients and doctors, leading to improved health outcomes.

## Getting Started

Before getting started, we strongly recommend you to install **Postman** app on your machine. Because, some type of requests are impossible to make from the browser. We also use, bash commands (mostly curl) for sending request to API

You can download Postman App for free by the link below:

[Download Postman | Get Started for Free](https://www.postman.com/downloads/)

## User Endpoints

`/auth/users/` → create new user | POST

`/auth/users/me/` → get current user | GET

`/auth/users/me/` → updates record | PATCH

`/auth/users/me/` → removes record from db | DELETE

`/auth/token/login/` → created new access and refresh token | POST

`/auth/token/refresh/` → get new access token by using refresh token | POST

## Hospital Endpoints

`/hospitals//`→ get details of hospital by ID | GET

`/nearest/hospitals`→ get list of nearest hospital | POST

## Video Endpoints

`/videos/` → get list of videos | GET

`/videos//`→ get details of video by ID | GET

## Notification Endpoints

`/notifications/` → get list of notifications | GET

`/notifications//`→ get details of notification by ID | GET

## Content Endpoints

`/contents/` → get list of notifications | GET

`/contents//`→ get details of content by ID | GET

`/contents//file/`→ get content of file by ID | GET

## Visit Endpoints

`/visits/` → get list of notifications | GET

`/visits//`→ get details of visit by ID | GET

## Sign Up

To access any data, first you (client) must create a user account. Without authentication, you cannot access to any data in database.

Endpoint to create new user record:

`/auth/users/`

Client must sent some required data which listed below

```json
// Request Body
{
"password": "string", // max -> 128 chars
"email": "string/email", // unique
"name": "string", // max -> 100 chars
"gender": "M",// only "F" or "M"
"birth_date": "2000-12-09", // format YYYY-MM-DD
"address": "Istanbul", //string
"category": 1, // cat ID -> 1 for User, 2 for Nurse
"longitude": 50.2, // double: 123.456789 | aaa.bbbbbb is valid data
"latitude": 25.1, // double: 123.456789 | aaa.bbbbbb is valid data
"marial_status": "S" // "S" -> single, "M" -> maried
}
```

When you send valid data, server responses the record which was created

```json
// Response
// Status: 201 Created
{
"id": 6,
"email": "[email protected]",
"name": "Abdulaziz Abduvakhobov",
"identity_number": null,
"gender": "M",
"birth_date": "2000-01-01",
"weight": null,
"height": null,
"address": "Tashkent",
"longitude": "50.200000",
"latitude": "25.100000",
"marial_status": "S",
"last_login": "2023-03-05T22:10:48.240671+03:00",
"category": 1
}
```

If you send invalid data or miss some fields, server will response which field is invalid

```json
// Response
// Status: 400 Bad Request
{
"password": [
"This field is required."
],
"email": [
"This field is required."
],
"name": [
"This field is required."
],
"gender": [
"This field is required."
],
"birth_date": [
"This field is required."
],
"address": [
"This field is required."
],
"longitude": [
"This field is required."
],
"latitude": [
"This field is required."
],
"marial_status": [
"This field is required."
],
"category": [
"This field is required."
]
}
```

Another example of invalid request

```json
// Request Body
{
"password": "1234",
"email": "[email protected]",
"first_name": "Abdulaziz",
"last_name": "abduvakhobov",
"gender": "M",
"birth_date": "2000-12-09",
"address": "Istanbul"
}
```

In this case, server checks validity of all fields, by default password value must be at least 8 characters

```json
// Response
// Status: 400 Bad Request
{
"longitude": [
"This field is required."
],
"latitude": [
"This field is required."
],
"marial_status": [
"This field is required."
],
"category": [
"This field is required."
]
}
```

## Authentication

After successfully creating of user record, client have to get access token in order to get access to data

**Token Endpoints:**

`/auth/token/login/` → creates new access and refresh **JWT (JSON Web Token)** token

`/auth/token/refresh/` → creates new access token by using refresh token

You must send **POST** request to get token. In the body of request client must enter **email** and **password** value

Example in Bash:

```bash
curl -X POST https://..../auth/token/login/
-H 'Content-Type: application/json'
-d '{"email":"my_mail","password":"my_password"}'
```

If data is valid, server will send access token

```json
// Response
// Status: 200 OK
{
"refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY4NjY4Mzg2OSwianRpIjoiYTM1NDZmYmU2OTg1NDlkZTg4ODVhZTBhMzQ5ZDBiYzQiLCJ1c2VyX2lkIjo0fQ.EBeBY6JpX5TQaP_Ek__3xi-zxb887uWXQQqtDOC2q48",
"access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjc4MTMwMjY5LCJqdGkiOiJmMWU0M2ZlZTgxYjc0MTFhODkwNDk2ZjUzMDViOTk1ZiIsInVzZXJfaWQiOjR9.hvH-uI0fX39Etug9rNYuOtRyNED8SbHtTlEA04FdODo"
}
```

Otherwise, it will send an error response

```json
// Response
// Status: 401 Unauthorized
{
"detail": "invalid email or password",
"access": null,
"refresh": null
}
```

After few days access token will be **expired** and you (user) can’t access data anymore with current access token. For not bother user each time, you must send **POST** request to get new access token with **refresh** token. In the body of request client must enter just refresh token.

Example in Bash:

```bash
curl -X POST http://...../api/v1/auth/token/refresh/' \
--data '{
"refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY4NjY4ODg0NCwianRpIjoiYWE2ZTdiOGE3N2M5NDU3YTlkOGQ1ZDc3ZTgwNDFjNjIiLCJ1c2VyX2lkIjo1fQ.04NV9HkNNbQXFuD-_HCrHTVqAaMESBsVKQB1B2ZIlfk"
}'
```

If data is valid, server will send access token

```json
// Response
// Status: 200 OK
{
"access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjc4MTMwMjY5LCJqdGkiOiJmMWU0M2ZlZTgxYjc0MTFhODkwNDk2ZjUzMDViOTk1ZiIsInVzZXJfaWQiOjR9.hvH-uI0fX39Etug9rNYuOtRyNED8SbHtTlEA04FdODo"
}
```

Otherwise, it will send an error response

```json
// Response
// Status: 401 Unauthorized
{
"detail": "Token is invalid or expired",
"code": "token_not_valid"
}
```

After getting `access` and `refresh` token client authenticated successfully and it can send almost every request. But keep in mind, you must set special header in order to access data.

### User Requests

**GET** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/users/me/
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
```

Server’s response:

```json
// Response
// Status: 200 OK
{
"id": 4,
"name": "Abdulaziz Abduvakhobov",
"email": "[email protected]",
"birth_date": "2000-01-01",
"address": "Tashkent",
"gender": "M",
"identity_number": null,
"weight": null,
"height": null,
"last_login": "2023-03-04T10:25:33.029392Z",
"longitude": 50.2,
"latitude": 25.1,
"marial_status": "S",
"category_name": "Nurse",
"category_id": 2
}
```

**PATCH** **Request Example**

```bash
curl --location --request PATCH 'https://${BASE_URL}/api/v1/auth/users/me/' \
--header 'Authorization: Token ${TOKEN} \
--data '{
"height": 170,
"weight": 72,
"identity_number": "12345678910"
}'
```

Server’s response:

```json
// Response
// Status: 200 OK
{
"id": 4,
"email": "[email protected]",
"name": "Abdulaziz Abduvakhobov",
"identity_number": "123456789",
"gender": "M",
"birth_date": "2000-01-01",
"weight": null,
"height": null,
"address": "Tashkent",
"longitude": "50.200000",
"latitude": "25.100000",
"marial_status": "S",
"last_login": "2023-03-05T22:27:59.738304+03:00",
"category": 1
}
```

**DELETE** **Request Example**

```bash
curl --location --request DELETE 'https://${BASE_URL}/api/v1/auth/users/me/' \
--header 'Authorization: Token ${TOKEN}'
```

Server’s response:

```json
// Response
// Status: 200 OK
{
"message": "User successfully deleted."
}
```

### Content Requests

**GET** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/contents/
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
```

Server’s response:

```json
// Response
// Status: 200 OK
[
{
"id": 1,
"title": "Hello World",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Faucibus et molestie ac feugiat sed lectus vestibulum mattis. Urna nec tincidunt praesent semper feugiat. Duis ultricies lacus sed turpis. Elementum integer enim neque volutpat ac tincidunt vitae semper quis.",
"date_created": "2023-04-18T22:04:48.290174+03:00",
"date_updated": "2023-04-18T22:04:48.290199+03:00",
},
{
"id": 2,
"title": "Guten Abend!",
"text": "Vestibulum lectus mauris ultrices eros in cursus turpis. Velit aliquet sagittis id consectetur purus ut faucibus. Dictum non consectetur a erat nam. Quam adipiscing vitae proin sagittis nisl rhoncus. Egestas integer eget aliquet nibh praesent tristique magna. Felis bibendum ut tristique et egestas. Cras pulvinar mattis nunc sed blandit libero volutpat sed. Magna fringilla urna porttitor rhoncus dolor purus non enim praesent. Dolor sit amet consectetur adipiscing elit pellentesque habitant morbi tristique. Et malesuada fames ac turpis.",
"date_created": "2023-04-18T22:04:48.290174+03:00",
"date_updated": "2023-04-18T22:04:48.290199+03:00",
}
]
```

**GET** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/contents/1/ # ID of Content
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
```

Server’s response:

```json
// Response
// Status: 200 OK
{
"id": 1,
"title": "Hello World",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Faucibus et molestie ac feugiat sed lectus vestibulum mattis. Urna nec tincidunt praesent semper feugiat. Duis ultricies lacus sed turpis. Elementum integer enim neque volutpat ac tincidunt vitae semper quis.",
"date_created": "2023-04-18T22:04:48.290174+03:00",
"date_updated": "2023-04-18T22:04:48.290199+03:00",
}
```

**GET** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/contents/1/file/ # ID of Content
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
```

Server’s response:

```html

Bootstrap demo

Hello, world!

```

### Video Requests

**GET** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/videos/
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
```

Server’s response:

```json
// Response
// Status: 200 OK
[
{
"id": 1,
"name": "New",
"url": "https://www.youtube.com/watch?v=YxG7PhZ3fb4",
"description": "Speed up your Rust code with Rayon",
"date_created": "2023-04-18T22:04:48.290174+03:00",
"date_updated": "2023-04-18T22:04:48.290199+03:00",
},
{
"id": 2,
"name": "Low Level Learning",
"url": "https://youtu.be/qWVRJsaUTIg",
"description": "Nam at lectus urna duis convallis convallis. Nunc pulvinar sapien et ligula. Lorem ipsum dolor sit amet consectetur. Etiam non quam lacus suspendisse faucibus interdum posuere lorem. Sit amet commodo nulla facilisi nullam vehicula ipsum. Velit scelerisque in dictum non consectetur a. Cursus turpis massa tincidunt dui ut ornare lectus sit. Pellentesque sit amet porttitor eget.",
"date_created": "2023-04-18T22:04:48.290174+03:00",
"date_updated": "2023-04-18T22:04:48.290199+03:00",
}
]
```

**GET** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/videos/2/ # ID of Video
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
```

Server’s response:

```json
// Response
// Status: 200 OK
{
"id": 2,
"name": "Low Level Learning",
"url": "https://youtu.be/qWVRJsaUTIg",
"description": "Nam at lectus urna duis convallis convallis. Nunc pulvinar sapien et ligula. Lorem ipsum dolor sit amet consectetur. Etiam non quam lacus suspendisse faucibus interdum posuere lorem. Sit amet commodo nulla facilisi nullam vehicula ipsum. Velit scelerisque in dictum non consectetur a. Cursus turpis massa tincidunt dui ut ornare lectus sit. Pellentesque sit amet porttitor eget.",
"date_created": "2023-04-18T22:04:48.290174+03:00",
"date_updated": "2023-04-18T22:04:48.290199+03:00",
}
```

### Hospital Requests

**GET** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/hospitals/53/ # ID of Hospital
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
```

Server’s response:

```json
// Response
// Status: 200 OK
{
"id": 53,
"city_name": "Adana",
"district_name": "Saimbeyli",
"date_created": "2023-04-23T16:33:40.541130+03:00",
"date_updated": "2023-04-23T16:33:40.752697+03:00",
"name": "ÖZEL ORTOPEDIA HASTANESİ - ORTOPEDIA ÖZEL SAĞLIK HİZMETLERİ TİC.A.Ş.",
"address": "Döşeme Mah. Cumhuriyet Cad. 64 Seyhan, Adana",
"phone": "03224327777",
"email": "[email protected]",
"website": "http://www.ortopedia.com.tr",
"longitude": "35.3185640000000",
"latitude": "36.9950300000000"
}
```

**POST** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/nearest/hospitals # without slash
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
--data-raw '{
"latitude": 41.025717927894824,
"longitude": 28.839039244671888
}'
```

Body of request

```json
# User's location
{
"latitude": 41.025717927894824,
"longitude": 28.839039244671888
}
```

Server’s response: List of **10 nearest hospitals**

```json
// Response
// Status: 200 OK
{
"hospitals": [
{
"id": 1212,
"name": "ÖZEL A HASTANESİ - A HOSPITAL SAĞLIK HİZMETLERİ LTD.ŞTİ.",
"address": "Kocasinan Merkez Mah. Mahmutbey Cad. 373-375 Bahçelievler, İstanbul",
"latitude": "41.0215873384960",
"longitude": "28.8392144232450",
"city_name": "İstanbul",
"district_name": "Bahçelievler",
"distance": 0.45953634645655844 # km
},
{
"id": 1189,
"name": "ÖZEL İSTANBUL MEDICINE HOSPITAL - EREN SAĞLIK HİZMETLERİ SAN. VE TİC.LTD.ŞTİ.",
"address": "Barbaros Mah. Hoca Ahmet Yesevi Cad. 149 Güneşli, Bağcılar, İstanbul",
"latitude": "41.0302620656710",
"longitude": "28.8387095093220",
"city_name": "İstanbul",
"district_name": "Bağcılar",
"distance": 0.5060423457838605
},
{
"id": 1199,
"name": "ÖZEL YENİ UFUK HASTANESİ - SOLMAZ ÖZEL SAĞLIK EĞİTİM HİZMETLERİ TİC.LTD.ŞTİ.",
"address": "İnönü Mah. 27. Sok. 4 Bağcılar, İstanbul",
"latitude": "41.0329590000000",
"longitude": "28.8558010000000",
"city_name": "İstanbul",
"district_name": "Bağcılar",
"distance": 1.620245258446413
},
{
"id": 1194,
"name": "ÖZEL HOSPITALIST HASTANESİ - ÖZEL HOSPITALIST BAĞCILAR SAĞLIK HİZMETLERİ SAN.TİC.A.Ş.",
"address": "Yavuzselim Mah. Hoca Ahmet Yesevi Cad. 26/A Sok. 5 Bağcılar, İstanbul",
"latitude": "41.0345400000000",
"longitude": "28.8550550000000",
"city_name": "İstanbul",
"district_name": "Bağcılar",
"distance": 1.6634610308045419
},
{
"id": 1213,
"name": "T.C.S.B. İSTANBUL FİZİK TEDAVİ REHABİLİTASYON EĞİTİM VE ARAŞTIRMA HASTANESİ",
"address": "Kocasinan Merkez Mah. Karadeniz Cad. 48 Bahçelievler, İstanbul",
"latitude": "41.0099161083830",
"longitude": "28.8446381032890",
"city_name": "İstanbul",
"district_name": "Bahçelievler",
"distance": 1.8187888707207216
},
{
"id": 1214,
"name": "T.C.S.B. İSTANBUL FİZİK TEDAVİ REHABİLİTASYON EĞİTİM VE ARAŞTIRMA HASTANESİ - YENİBOSNA EK HİZMET BİNASI",
"address": "Yenibosna Merkez Mah. Ayvaz Cami Sok. 4 Yenibosna Ek Hizmet Binası Bahçelievler, İstanbul",
"latitude": "41.0122830000000",
"longitude": "28.8234020000000",
"city_name": "İstanbul",
"district_name": "Bahçelievler",
"distance": 1.9881678907611782
},
{
"id": 1195,
"name": "ÖZEL YENİ İKLİM HASTANESİ - SOLMAZ ÖZEL SAĞLIK EĞİTİM HİZMETLERİ TİC.LTD.ŞTİ.",
"address": "Sancaktepe Mah. 892. Sok. 5 Bağcılar, İstanbul",
"latitude": "41.0367029073560",
"longitude": "28.8580800172180",
"city_name": "İstanbul",
"district_name": "Bağcılar",
"distance": 2.010690230689927
},
{
"id": 1196,
"name": "ÖZEL GÜNEŞLİ ERDEM HASTANESİ - ÇAKMAK ÖZEL SAĞLIK HİZMETLERİ LTD.ŞTİ.",
"address": "Güneşli Mah. Fevzi Çakmak Cad. 74 Bağcılar, İstanbul",
"latitude": "41.0405530000000",
"longitude": "28.8251490000000",
"city_name": "İstanbul",
"district_name": "Bağcılar",
"distance": 2.0195438403242845
},
{
"id": 1208,
"name": "T.C.S.B. BAHÇELİEVLER DEVLET HASTANESİ",
"address": "Kocasinan Merkez Mah. Karadeniz Cad. 48 Bahçelievler, İstanbul",
"latitude": "41.0063053348260",
"longitude": "28.8442947804830",
"city_name": "İstanbul",
"district_name": "Bahçelievler",
"distance": 2.20316048238313
},
{
"id": 1211,
"name": "SANTE PLUS HOSPİTAL - BEKA SAĞLIK EĞİTİM TIBBİ MALZEMELER TEKSTİL TURİZM GIDA SAN. VE TİC.LTD.ŞTİ.",
"address": "Yenibosna Merkez Mah. 29 Ekim Cad. 28 Bahçelievler, İstanbul",
"latitude": "41.0122420000000",
"longitude": "28.8184760000000",
"city_name": "İstanbul",
"district_name": "Bahçelievler",
"distance": 2.2850793310287014
}
]
}
```

### Appointments

**GET** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/visits/
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
```

Server’s response:

```json
// Response
// Status: 200 OK
[
{
"id": 1,
"datetime": "2023-03-04T13:14:20+03:00",
"location": "Virtual Office",
"visitor": 2, // ID of User
"user": 1, // ID of User
"date_created": "2023-04-18T22:04:48.290174+03:00",
"date_updated": "2023-04-18T22:04:48.290199+03:00",
},
{
"id": 2,
"datetime": "2023-03-05T22:09:54+03:00",
"location": "Tashkent",
"visitor": 2, // ID of User
"user": 5, // ID of User
"date_created": "2023-04-18T22:04:48.290174+03:00",
"date_updated": "2023-04-18T22:04:48.290199+03:00",
}
]
```

**GET** **Request Example**

```bash
curl -X GET https://..../api/v1/auth/visits/2/ # ID of Visit
-H 'Content-Type: application/json'
-H 'Authorization: Token ${TOKEN}'
```

Server’s response:

```json
// Response
// Status: 200 OK
{
"id": 2,
"datetime": "2023-03-05T22:09:54+03:00",
"location": "Tashkent",
"visitor": 2, // ID of User
"user": 5, // ID of User
"date_created": "2023-04-18T22:04:48.290174+03:00",
"date_updated": "2023-04-18T22:04:48.290199+03:00",
}
```