DiaGram API Server

This is the API Node.js server code for the app DiaGram written for CPEN-321

Table of Contents

1. Session
   • Patient Signup
   • Doctor Signup
   • Patient Login
   • Doctor Login
2. Posts
   • Get Post
   • Make Post
   • Commenting
   • Get Followed Post
3. Users
   • View Profile
   • Edit Patient's Profile
   • Edit Doctor's Profile
   • Patient View Other Profile
   • Doctor View Other Profile
4. Common Error Responses

Session

Patient Signup

Creates a patient user

• URL

  /signup

• Method:

  POST

• URL Body

  Required:

  username: <String> (5-32 characters)
  password: <String> (8-64 characters)
  accessCode: <String>
  

  Optional:

  firstName: <String>
lastName: <String>
medications: <String>
recentProcedures: <String>
conditions: <String>
  

• Success Response:

  • Code: 200
    Content:
    

    {
        jwt: <String>,
        user: {
            _id: <String>,
            username: <String>,
            userType: <String>,
            firstName: <String>,
            lastName: <String>,
            medications: <String>,
            recentProcedures: <String>,
            conditions: <String>,
        }
    }
    

• Error Response:

  • Code: 400 BAD REQUEST
    Content:
    { errors : [ "DUPLICATE_USERNAME", "INVALID_ACCESS_CODE", "INVALID_USERNAME", "INVALID_PASSWORD" ] }

Doctor Signup

Creates a doctor user

• URL

  /signup

• Method:

  POST

• URL Body

  Required:

  username: <String> (5-32 characters)
  password: <String> (8-64 characters)
  accessCode: <String>
  

  Optional:

  firstName: <String>
lastName: <String>
experience: <String>
department: <String>
specializations: <String>
  

• Success Response:

  • Code: 200
    Content:
    

    {
        jwt: <String>,
        user: {
            _id: <String>,
            username: <String>,
            userType: <String>,
            firstName: <String>,
            lastName: <String>,
            experience: <String>,
            department: <String>,
            specializations: <String>,
        }
    }
    

• Error Response:

  • Code: 400 BAD REQUEST
    Content:
    { errors : [ "DUPLICATE_USERNAME", "INVALID_ACCESS_CODE", "INVALID_USERNAME", "INVALID_PASSWORD" ] }

Patient Login

Grant session to a patient user given the username and password

• URL

  /login

• Method:

  POST

• URL Body

  Required:

  username: <String>
password: <String>
  

• Success Response:

  • Code: 200
    Content:
    

    {
        jwt: <String>,
        user: {
            _id: <String>,
            username: <String>,
            userType: <String>,
            firstName: <String>,
            lastName: <String>,
            medications: <String>,
            recentProcedures: <String>,
            conditions: <String>,
        }
    }
    

• Error Response:

  • Code: 400 BAD REQUEST
    Content:
    { errors : [ "INVALID_CREDENTIALS" ] }

Doctor Login

Grant session to a doctor user given the username and password

• URL

  /login

• Method:

  POST

• URL Body

  Required:

  username: <String>
password: <String>
  

• Success Response:

  • Code: 200
    Content:
    

    {
        jwt: <String>,
        user: {
            _id: <String>,
            username: <String>,
            userType: <String>,
            firstName: <String>,
            lastName: <String>,
            experience: <String>,
            department: <String>,
            specializations: <String>,
        }
    }
    

• Error Response:

  • Code: 400 BAD REQUEST
    Content:
    { errors : [ "INVALID_CREDENTIALS" ] }

Posts

Get Posts

Get posts for app feed

• URL

  /posts

• Method:

  GET

• URL HEADER

  Required:

  Authorization: "Bearer ${jwt}"

• Success Response:

  • Code: 200
    Content:
    

    [
      {
        _id: <String>,
        tite: <String>,
        body: <String>,
        userId: <String>,
        userType: enum { patient, doctor },
        private: <Boolean>,
        comments: [
          {
            body: <String>,
            userId: <String>,
            docLastName: <String>,
            userType: enum { patient, doctor },
            createdAt: <Timestamp>
          },
          ...
        ],
        createdAt: <Timestamp>,
        updatedAt: <Timestamp>
      },
      ...
    ]
    

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content:
    { errors : [ "UNAUTHORIZED", "SESSION_EXPIRED" ] }

Get Post

Get single post

• URL

  /posts?post_id=<postId>

• Method:

  GET

• URL HEADER

  Required:

  Authorization: "Bearer ${jwt}"

• Success Response:

  • Code: 200
    Content:
    

    [
        {
          _id: <String>,
          tite: <String>,
          body: <String>,
          userId: <String>,
          userType: enum { patient, doctor },
          private: <Boolean>,
          comments: [
            {
              body: <String>,
              userId: <String>,
              docLastName: <String>,
              userType: enum { patient, doctor },
              createdAt: <Timestamp>
            },
            ...
          ],
          createdAt: <Timestamp>,
          updatedAt: <Timestamp>
        }
    ]
    

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content:
    { errors : [ "UNAUTHORIZED", "SESSION_EXPIRED" ] }

Make Post

Make a new post

• URL

  /posts

• Method:

  POST

• URL HEADER

  Required:

  Authorization: "Bearer ${jwt}"

• URL Body

  Required:

  title: <String>
body: <String>
  

  Optional:

  private: <Boolean>
  

• Success Response:

  • Code: 200
    Content:
    

    {
      _id: <String>,
      tite: <String>,
      body: <String>,
      userId: <String>,
      userType: enum { patient, doctor },
      private: <Boolean>,
      comments: [],
      createdAt: <Timestamp>,
      updatedAt: <Timestamp>
    }
    

• Error Response:

  • Code: 400 BAD REQUEST
    Content:
    { errors : [ "EMPTY_TITLE", "EMPTY_BODY" ] }

  • Code: 401 UNAUTHORIZED
    Content:
    { errors : [ "UNAUTHORIZED", "SESSION_EXPIRED" ] }

Commenting

Comments on a post, only permissible by doctor userType and OP

• URL

  /posts/:post_id/comments

• Method:

  POST

• URL HEADER

  Required:

  Authorization: "Bearer ${jwt}"

• URL Body

  Required:

  body: <String>
  

• Success Response:

  • Code: 200
    Content:
    

    {
      _id: <String>,
      tite: <String>,
      body: <String>,
      userId: <String>,
      userType: enum { patient, doctor },
      private: <Boolean>,
      comments: [ {newly added comment} ],
      createdAt: <Timestamp>,
      updatedAt: <Timestamp>
    }
    

• Error Response:

  • Code: 400 BAD REQUEST
    Content:
    { errors : [ "POST_NOT_FOUND" ] }

  • Code: 401 UNAUTHORIZED
    Content:
    { errors : [ "UNAUTHORIZED", "SESSION_EXPIRED" ] }

  • Code: 403 FORBIDDEN
    Content:
    { errors : [ "WRONG_USER" ] }

Get Followed Posts

Get posts that the user is following. Posts are automatically followed by a user they make the post, and followed by a doctor if they comment on it.

• URL

  /posts/followed

• Method:

  GET

• URL HEADER

  Required:

  Authorization: "Bearer ${jwt}"

• Success Response:

  • Code: 200
    Content:
    

    [
      {
        _id: <String>,
        tite: <String>,
        body: <String>,
        userId: <String>,
        userType: enum { patient, doctor },
        private: <Boolean>,
        comments: [
          {
            body: <String>,
            userId: <String>,
            docLastName: <String>,
            userType: enum { patient, doctor },
            createdAt: <Timestamp>
          },
          ...
        ],
        createdAt: <Timestamp>,
        updatedAt: <Timestamp>
      },
      ...
    ]
    

Users

Edit Patient Profile

edit the patients profile information, returns updated information

• URL

  /users

• Method:

  PUT

• URL HEADER

  Required:

  Authorization: "Bearer ${jwt}"

• Body

  Optional:
  firstName: <String>
lastName: <String>
medications: <String>
recentProcedures: <String>
conditions: <String>

• Success Response:

  • Code: 200
    Content:
    

    {
      _id: <String>
      username: <String>
      userType: enum { patient, doctor },
      firstName: <String>
      lastName: <String>
      medications: <String>
      recentProcedures: <String>
      conditions: <String>
    }
    

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content:
    { errors : [ "UNAUTHORIZED", "SESSION_EXPIRED" ] }

Edit Doctor Profile

edit the doctor's profile information, returns updated information

• URL

  /users

• Method:

  PUT

• URL HEADER

  Required:

  Authorization: "Bearer ${jwt}"

• Body

  Optional:
  firstName: <String>
lastName: <String>
experience: <String>
specializations: <String>
department: <String>

• Success Response:

  • Code: 200
    Content:
    

    {
      _id: <String>
      username: <String>
      userType: enum { patient, doctor },
      firstName: <String>
      lastName: <String>
      experience: <String>
      specializations: <String>
      department: <String>
    }
    

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content:
    { errors : [ "UNAUTHORIZED", "SESSION_EXPIRED" ] }

Patient View Other Profile

get the profile information of another user

• URL

  /users/:user_id

• Method:

  GET

• URL HEADER

  Required:

  Authorization: "Bearer ${jwt}"

• Success Response:

  • Code: 200
    Content:
    

    If profile is of a doctor

    {
      _id: <String>
      username: <String>
      userType: enum { patient, doctor },
      firstName: <String>
      lastName: <String>
      experience: <String>
      department: <String>
      specializations: <String>
    }
    

    If profile is another patient

    {
      _id: <String>
      userType: enum { patient, doctor },
      medications: <String>
      recentProcedures: <String>
      conditions: <String>
    }
    

• Error Response:

  • Code: 400 user_id provided doesn't exist
    Content:
    { errors : [ "INVALID_USER_ID" ] }

  • Code: 401 UNAUTHORIZED
    Content:
    { errors : [ "UNAUTHORIZED", "SESSION_EXPIRED" ] }

Doctor View Other Profile

get the profile information of another user

• URL

  /users/:user_id

• Method:

  GET

• URL HEADER

  Required:

  Authorization: "Bearer ${jwt}"

• Success Response:

  • Code: 200
    Content:
    

    If profile is of another doctor

    {
      _id: <String>
      username: <String>
      userType: enum { patient, doctor },
      firstName: <String>
      lastName: <String>
      experience: <String>
      department: <String>
      specializations: <String>
    }
    

    If profile is a patient

    {
      _id: <String>
      username: <String>
      userType: enum { patient, doctor },
      firstName: <String>
      lastName: <String>
      medications: <String>
      recentProcedures: <String>
      conditions: <String>
    }
    

• Error Response:

  • Code: 400 user_id provided doesn't exist
    Content:
    { errors : [ "INVALID_USER_ID" ] }

  • Code: 401 UNAUTHORIZED
    Content:
    { errors : [ "UNAUTHORIZED", "SESSION_EXPIRED" ] }

Common Error Responses

• INTERNAL SERVER ERROR
  happens when there is something wrong with the server internally

  • Code: 500
    Content:
    { errors : [ "INTERNAL_SERVER_ERROR" ] }

• NOT FOUND
  happens the URL does not exist

  • Code: 404
    Content:
    { errors : [ "NOT_FOUND" ] }