moyo_backend

Table of Contents

• 1. API Documentation
  • 1.1. Users
    • Moyo User Registration
    • User Login
  • 1.2. AWS
    • Upload to S3
• 2. Contributors

1. API Documentation

This is the API documentation for the back end of Amoss App. The data will be stored in AWS S3 bucket.

1.1. Users

Moyo User Registration

This route is present for the registration of Moyo users

Path:

POST | http://localhost:4200/api/createAdmin POST | http://localhost:4200/api/createCoordinator POST | http://localhost:4200/api/createPatient

Params:

Status Codes:

Example Body:

Header |
--- | 
Authorization : Bearer ey...s

Example Response:

{"success":"patient participant created"}
{"success": "you have completed upload to S3Bucket}

Example Failure Response:

{
    "error": "json parsing error",
    "error description": "key or value of json is formatted incorrectly"
}

User Login

This route is present for the login of users

Path:

Params:

Status Codes:

Example Body:

{
  "participantID":yourParticipantID,
  "password":"yourPassword"
}

Example Response:

{
    "token": "eyJ...........co",
    "capacity": "coordinator",
    "participantID": "yourParticipantID",
    "study": "study_name",
    "isConsented": "false"
}

Example Failure Response:

{
    "error": "json parsing error",
    "error description": "key or value of json is formatted incorrectly"
}

1.2. AWS

Upload to S3

This route is present for the Amazon S3 file uploads

Path:

Headers:

Params:

Status Codes:

Example Header:

Authorization: Mars fd..Y,

Example Body:

{
  "path": "S3PathFolder",
  "weekMillis": 534118400000
  "upload": "YourFile"
}

Example Response:

{
  "success": "you have completed upload to awsS3Bucket"
}

2. Contributors

Daniel Phan && Tony Nguyen

Update: August 15, 2021

README documentation by Daniel Phan