Health Portrait

To view an example of how our application works, feel free to use the login below:

username: mariasd password: 123

Running Locally

• Run npm run serve, which compiles the frontend for hot-reloading with webpack and serves it at port 8080.
• Open a new terminal (with the original one still open) and run npm run dev to start the backend at port 3000.
• To view the website, connect to localhost:8080

API Routes

Shared Account

POST /api/accounts - Create a shared account

Body

• name {string} - The shared account owner's name
• username {string} - The user's username
• password {string} - The user's password

Returns

• A success message
• The created shared account's details
• The username registered

Throws

• 403 if there is a user already logged in
• 400 if name is empty or missing
• 400 if username or password is not in correct format or missing
• 409 if username is already in use

PATCH /api/accounts - Update a shared account's details

Body

• name {string} - The new name for the shared account

Returns

• A success message
• The updated shared account details

Throws

• 401 if the user is not logged in
• 400 if name is empty

DELETE /api/accounts - Delete a shared account

Returns

• A success message

Throws

• 401 if the user is not logged in

POST /api/accounts/credentials - Create a credential for a shared account

Body

• username {string} - The user's username
• password {string} - The user's password

Returns

• A success message
• The created shared account's details

Throws

• 401 if the user is not logged in
• 400 if username or password is not in correct format or missing
• 409 if username is already in use

PATCH /api/accounts/credentials - Update the session credential's details

Body

• username {string} - The user's new username (optional)
• password {string} - The user's new password (optional)

Returns

• A success message
• The updated shared account details
• The updated username

Throws

• 401 if the user is not logged in
• 400 if username or password is not in correct format
• 400 if username and password are both missing

DELETE /api/accounts/credentials/:username - Delete a credential from the shared account

Returns

• A success message
• The updated shared account details

Throws

• 401 if the user is not logged in
• 404 if no credential with username username exists
• 403 if the credential username doesn't belong to the user's shared account

GET /api/accounts/session - Get the session shared account

Returns

• A success message
• The signed in shared account's details, or null if not signed in
• The username used to authenticate, or null if not signed in

POST /api/accounts/session - Sign in user

Body

• username {string} - The user's username
• password {string} - The user's password

Returns

• A success message
• The shared account's details
• The username used to authenticate

Throws

• 403 if the user is already logged in
• 400 if username or password is not in correct format or missing
• 401 if the user login credentials are invalid

DELETE /api/accounts/session - Sign out user

Returns

• A success message

Throws

• 401 if user is not logged in

Insurance Card

GET /api/insurance-cards - Get a user's insurance cards

Returns

• An array of insurance cards created by the user in alphabetical order with respect to their purpose

Throws

• 401 if user is not logged in

POST /api/insurance-cards - Create a new insurance card

Body

• subscriber_name {string} - The insurance card's subscriber
• member_id {string} - The insurance card's member ID (optional)
• group_number {string} - The insurance card's group number (optional)
• plan_number {string} - The insurance card's plan number (optional)
• plan_type {string} - The insurance card's plan type (optional)
• purpose {string} - The insurance card's purpose
• notes {string} - Notes about the insurance card (optional)

Returns

• A success message
• A object with the created insurance card

Throws

• 401 if the user is not logged in
• 400 If the subscriber_name or purpose is empty or a stream of empty spaces

PATCH /api/insurance-cards/:insuranceCardId - Edit the information of an insurance card

Body

• subscriber_name {string} - The insurance card's subscriber (optional)
• member_id {string} - The insurance card's member ID (optional)
• group_number {string} - The insurance card's group number (optional)
• plan_number {string} - The insurance card's plan number (optional)
• plan_type {string} - The insurance card's plan type (optional)
• purpose {string} - The insurance card's purpose (optional)
• notes {string} - Notes about the insurance card (optional)

Returns

• A success message
• A object with the edited insurance card

Throws

• 401 if the user is not logged in
• 403 if the user is not the owner of the insurance card
• 400 If the subscriber_name or purpose is empty or a stream of empty spaces
• 404 if the insuranceCardId is invalid

DELETE /api/insuranceCards/:insuranceCardId - Delete an insurance card

Returns

• A success message

Throws

• 401 if the user is not logged in
• 403 if the user is not the owner of the insurance card
• 404 if the insuranceCardId is invalid

Medical Contact

GET /api/medical-contacts - Get a user's medical contacts

Returns

• An array of medical contacts created by user in alphabetical order with respect to the last name of the contact

Throws

• 401 if the user is not logged in

POST /api/medical-contacts - Create a new medical contact

Body

• active {string} - Whether the medical contact is in use or not
• title {string} - The medical contact's title
• first_name {string} - The medical contact's first name
• last_name {string} - The medical contact's last name
• hospital {string} - The medical contact's associated hospital (optional)
• specialty {string} - The medical contact's specialty (optional)
• phone_number {string} - The medical contact's phone number
• notes {string} - Notes about the medical contact (optional)

Returns

• A success message
• A object with the created medical contact

Throws

• 401 if the user is not logged in
• 400 If the first_name or last_name is empty or a stream of empty spaces
• 400 If the phone_number is not a valid phone number (https://stackoverflow.com/a/16699507)

PATCH /api/medical-contacts/:medicalContactId - Edit the information of a medical contact

Body

• active {string} - Whether the medical contact is in use or not (optional)
• title {string} - The medical contact's title (optional)
• first_name {string} - The medical contact's first name (optional)
• last_name {string} - The medical contact's last name (optional)
• hospital {string} - The medical contact's associated hospital (optional)
• specialty {string} - The medical contact's specialty (optional)
• phone_number {string} - The medical contact's phone number (optional)
• notes {string} - Notes about the medical contact (optional)

Returns

• A success message
• A object with the edited medical contact

Throws

• 401 if the user is not logged in
• 403 if the user is not the owner of the medical contact
• 400 If the first_name or last_name is empty or a stream of empty spaces
• 400 If the phone_number is not a valid phone number (https://stackoverflow.com/a/16699507)
• 404 if the medicalContactId is invalid

DELETE /api/medical-contacts/:medicalContactId - Deactivates a medical contact

Returns

• A success message

Throws

• 401 if the user is not logged in
• 403 if the user is not the owner of the medical contacts
• 404 if the medicalContactId is invalid
• 409 if the medicalContactId is already deactivated

Medication

GET /api/medications - Get a user's medications

Returns

• An array of medications created by the user in alphabetical order with respect to the name of the medication

Throws

• 401 if the user is not logged in

POST /api/medications - Create a new medication

Body

• name {string} - The medication's name
• generic_name {string} - The medication's generic compound name
• dose {string} - The medication's dose
• notes {string} - Notes about the medication

Returns

• A success message
• A object with the created medication

Throws

• 401 if the user is not logged in
• 400 If the name or dose is empty or a stream of empty spaces

PATCH /api/medications/:medicationId - Edit the information of a medication

Body

• name {string} - The medication's name (optional)
• generic_name {string} - The medication's generic compound name (optional)
• dose {string} - The medication's dose (optional)
• notes {string} - Notes about the medication (optional)

Returns

• A success message
• A object with the edited medication

Throws

• 401 if the user is not logged in
• 403 if the user is not the owner of the medication
• 400 If the name or dose is empty or a stream of empty spaces
• 404 if the medicationId is invalid

DELETE /api/medications/:medicationId - Deactivates a medication

Returns

• A success message

Throws

• 401 if the user is not logged in
• 403 if the user is not the owner of the medication
• 404 if the medicationId is invalid
• 409 if the medicationId is already deactivated

Entry

GET /api/entries - Get all entries of the user

Returns

• The array of entries by the user sorted in descending order by date

Throws

• 401 if the user is not logged in

POST /api/entries - Make a new entry in the log

Body

• type {string} - The type of the log entry
• detail {string} - The detail of the log entry
• condition {string} - The condition of the log entry
• scale {string} - The scale of the log entry
• notes {string} - The log entry's notes (optional)
• date {Date} - The date associated with the log entry

Returns

• A success message
• The newly created entry object

Throws

• 401 if the user is not logged in
• 400 if the type, detail, or condition is empty or a stream of empty spaces
• 400 if given type, condition, or scale is not in specified set of valid inputs
• 400 if date is empty/an invalid timestamp
• 404 if detail references a record that is doesn't exist
• 403 if detail references a record that is not owned by the user

PATCH /api/entries/:entryId - Editing an entry in the log

Body

• type {string} - The type of the log entry (optional)
• detail {string} - The detail of the log entry (optional)
• condition {string} - The condition of the log entry (optional)
• scale {string} - The scale of the log entry (optional)
• notes {string} - The log entry's notes (optional)
• date {Date} - The date associated with the log entry (optional)

Returns

• A success message
• The updated entry object

Throws

• 401 if the user is not logged in
• 404 if the entryId is invalid
• 403 if the user is not the owner of the entry
• 400 if the type, detail, or condition is empty or a stream of empty spaces
• 400 if given type, condition, or scale is not in specified set of valid inputs
• 400 if date is empty/an invalid timestamp
• 404 if detail references a record that is doesn't exist
• 403 if detail references a record that is not owned by the user

DELETE /api/entries/:entryId - Delete an entry in the log

Returns

• A success message

Throws

• 401 if the user is not logged in
• 404 if the entryId is invalid
• 403 if the user is not the owner of the entry