E-HealthCard 👨‍⚕️

Build Instructions

$ pip3 install -r requirements.txt

Then execute run.sh file:

$ ./run.sh
...

API

List all the users

Definition

GET /api/users/all (Login required)

Response

• 200 OK on success
• 401 UNAUTHORIZED on unauthorized access

[
    {
        "aadhar_card": "123214983204",
        "address": "Shivanand Bungalows B/H Annapurna Restaurant Jashodanagar",
        "avatar": "https://www.gravatar.com/avatar/4edab099fecc10e6f090d5567ab7c2aa?d=identicon&s=128",
        "email": "ninad.sachania@gmail.com",
        "firstname": "Ninad",
        "id": 1,
        "lastname": "Sachania",
        "middlename": "Jaimin",
        "phone_number": "9099869696",
        "rfid": null
    }
]

It will return an empty array ([]) if there are no users.

Get a token

Definition

POST /api/users/token

Arguments

This API call expects "Basic" authentication scheme. In that:

• The username and the password are combined with a colon (aladdin:opensesame).
• The resulting string is base64 encoded (YWxhZGRpbjpvcGVuc2VzYW1l).

Then Authorization header is included with the <type> as "Basic" and <credentials> as the base64 encoded string:

Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l

Response

• 200 OK on success

{
    "token": "4Id5JpPZ3NtYUgqlcNy5m12mjrbytZxt"
}

If you make a call and a token is already present then that token is returned instead of a new token.

• 401 UNAUTHORIZED when the username or password fields are missing or empty

{
    "error": "Unauthorized"
}

Revoking a token

Definition

DELETE /api/users/token

Response

• 200 OK on success

{
    "message": "Token delete successfully."
}

• 401 UNAUTHORIZED when the token is wrong on not present

{
    "error": "Unauthorized"
}

Get a user's information

Definition

GET /api/users (Authorization required)

Response

• 200 OK on success

{
    "aadhar_card": "123214983204",
    "address": "Shivanand Bungalows B/H Annapurna Restaurant Jashodanagar",
    "avatar": "https://www.gravatar.com/avatar/4edab099fecc10e6f090d5567ab7c2aa?d=identicon&s=128",
    "email": "ninad.sachania@gmail.com",
    "firstname": "Ninad",
    "id": 1,
    "lastname": "Sachania",
    "middlename": "Jaimin",
    "phone_number": "9099869696",
    "rfid": null
}

• 401 UNAUTHORIZED when the token is wrong on not present

{
    "error": "Unauthorized"
}

Creating a user

Definition

POST /api/users (Authorization required)

Arguments

• firstname: string
• middlename: string
• lastname: string
• email: string
• aadhar_card: string The aadhar_card of the user (it should be 12 in length).
• phone_number: string It should be 10 in length.
• address: string The address of the user
• password: string

Response

• 201 CREATED on success

{
    "aadhar_card": "123456789012",
    "address": "India",
    "avatar": "https://www.gravatar.com/avatar/c89cf6721f229f50dfddb66873f6779e?d=identicon&s=128",
    "email": "sagar.gohil@gmail.com",
    "firstname": "Sagar",
    "id": 3,
    "lastname": "Gohil",
    "middlename": "B",
    "phone_number": "9099869695",
    "rfid": null
}

• 409 CONFLICT if the email, phone_number or aadhar_card already exists.

{
    "error": "Conflict",
    "message": "Sorry! This email is already in use"
}

{
    "error": "Conflict",
    "message": "Sorry! This phone number is already in use."
}

{
    "error": "Conflict",
    "message": "Sorry! This aadhar number is already in use."
}

Updating a user's profile

Definition

PUT /api/users (Authorization required)

Arguments

• firstname: string
• middlename: string
• lastname: string
• address: string The address of the user

Response

• 200 OK on success

The response will contain the user's details.

{
    "aadhar_card": "123214983204",
    "address": "Shivanand Bungalows B/H Annapurna Restaurant Jashodanagar.",
    "avatar": "https://www.gravatar.com/avatar/4edab099fecc10e6f090d5567ab7c2aa?d=identicon&s=128",
    "email": "ninad.sachania@gmail.com",
    "firstname": "Ninad",
    "id": 1,
    "lastname": "Sachania",
    "middlename": "Jaimin",
    "phone_number": "9099869696",
    "rfid": null
}

• 400 BAD REQUEST if you the request tries to change email, aadhar_card or the phone_number of the user.

{
    "error": "Bad Request",
    "message": "Can't change email, aadhar_card and phone_number."
}

• 400 BAD REQUEST if the request contains an unknown field

{
    "error": "Bad Request",
    "message": "Unknown key: firstnae"
}

Get a user's static information

Definition

GET /api/users/static_information (Authorization required)

Response

• 200 OK on success

{
    "allergies": "From stupid people.",
    "bloodgroup": "A+",
    "current_medication": "Vitamin B12",
    "dob": "Tue, 07 Jul 1998 00:00:00 GMT",
    "emergency_contact": "9099869696",
    "gender": "Male",
    "height": 180,
    "id": 1,
    "weight": 71.0
}

• 204 NO CONTENT if there is no static information

Updating a user's static information

Definition

PUT /api/users/static_information (Authorization required)

Arguments

• dob: date Date of Birth
• gender: string
• emergency_contact: string Length should be 10
• height: string
• weight: string
• bloodgroup: string
• allergies: string
• current_medication: string

Get a user's dynamic records

Definition

GET /api/users/dynamic_information (Authorization required)

Response

• 200 OK on success

[
    {
        "date_created": "Mon, 16 Mar 2020 12:26:14 GMT",
        "diagnosis": "Flu",
        "doctor_id": 1,
        "id": 1,
        "next_case_id": 0,
        "notes": "",
        "prescribed_medication": "Rest",
        "previous_case_id": 0,
        "symptoms": "Cold, dry cough, runny nose."
    },
    {
        "date_created": "Mon, 16 Mar 2020 12:34:33 GMT",
        "diagnosis": "Food poisoning",
        "doctor_id": 1,
        "id": 2,
        "next_case_id": 0,
        "notes": "Plenty of rest and high intake of fluids.",
        "prescribed_medication": "Rest and Paracetamol",
        "previous_case_id": 0,
        "symptoms": "Stomachache"
    }
]

• 204 NO CONTENT if there are no dynamic records present

Change a user's password

Definition

POST /api/users/changepw (Authorization required)

Arguments

• current_password: string
• new_password: string

Response

• 200 OK on success

{
    "message": "Password successfully changed."
}

• 401 UNAUTHORIZED when the token is wrong on not present

{
    "error": "Unauthorized"
}

• 400 BAD REQUEST when the current password is incorrect.

{
    "error": "Bad Request",
    "message": "Current password incorrect. Please try again."
}

• 400 BAD REQUEST if current_password and/or new_password fields are missing in the request

{
    "error": "Bad Request",
    "message": "'current_password' and 'new_password' fields are required."
}

Reset forgotten password

Definition

POST /api/users/reset_password_request

Arguments

• email: string The email id of the user

Response

• 200 OK on success

{
    "message": "Check your email for instructions to reset your password."
}

• 400 BAD REQUEST when a email of a non-existent account is passed as arguments

{
    "error": "Bad Request",
    "message": "Sorry! Email 'xyz@gmail.com' not found."
}

Getting QR Code

Definition

POST /api/users/qrcode (Authorization required)

Arguments

No arguments required.

Response

• 200 OK on success

{
    "path": "/static/qrcodes/5.png"
}

• 400 BAD REQUEST if the user's has not filled out their static information

{
    "error": "Bad Request",
    "message": "To generate a QR code first fill out your static information."
}