Versions Compared

Old Version 40

changes.mady.by.user Unknown User (zl469)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (zl942)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The test server ip-address:port is https://dashboard-test.diaper-project.com:5000

The production server ip-address:port is https://dashboard-prod.diaper-project.com:5000

The production server AWS Chalice:port is https://4wuiajclt6.execute-api.us-east-1.amazonaws.com/api/ (No Longer in Use)


URL/api/login/
DescriptionLogin a user, and set cookie for authentication
MethodPOST
Url Param
Request Body Data
  1. HTML Form Submission with fields:
    1. email (string)
    2. password (string)
    3. remember_me (optional boolean)
  2. Alternatively, you can manually add following fields in request body as a json format:
    1. email (string)
    2. password (string)
    3. remember_me (optional boolean)
    4. formdata (empty string)
Response
  • {message: "Logged in."} - 200
  • {message: "Bad request format"} - 400
  • {message: "invalid credential(s) provided, please check your credential(s) and try again"} - 400/401
Cookie
  • session: a cookie for trace login status
  • remember_token: a cookie for remember_me feature (only when logged in with remember_me set to true)

...

URL/api/registration/
DescriptionRegister a new user.
MethodPOST
Url Param
Request Body Data
  1. HTML Form Submission with fields:
    1. email (string)
    2. username password (string)
    3. confirm_password (string)
    4. password2 user_type (string)
  2. Alternatively, you can manually add following fields in request body as a json format:
    1. email (string)string）
    2. username password (string)
    3. confirm_password (string)
    4. password2 user_type (string)
    5. formdata (!EMPTY! string)
Response
  • {message: "Registered, please login."} - 200
  • {message: "Data input is not valid, please try again"} - 400
Cookie


...

URL /api/upload/
Description

GET: Fetching all uploaded species reads

PUT: Upload a species read

HeaderAPI_KEY
MethodPUT | GET
Url Param

--

Request Body Data

GET

---

PUT

{       

        "email":"XXXXX",

        "barcode_id":"XXXXX",
        "sample_id":"XXXX",
        "sample_species_read": {
                "Actinotignum_timeonense": "XX",
                "Aeriscardovia_aeriphila": "X",

                ...
                }
}

 

"Response

PUT

  • { message: “file uploaded” } - 200: Success


 GET

{
        "read_list": [
                {
                        "_id": "XXXX",
                        "date_time": "XXXXXXX",
                        "email": "diapertestemail@gmail.com",
                        "sample_id": "XXX",
                        "sample_species_read": {
                                "Actinotignum_timeonense": "XX",
                                "Aeriscardovia_aeriphila": "XX",

                                ...
                         }
                },

                ...
         ],
         "nums": XX
}

 

200: Success

URL /api/stool-color/
Description

GET: Fetching all barcodes with their associated color

MethodGET
Request Body Data


Response
{
  "colors": [
    {
      "barcode_id": "XXXXX", 
      "color": "XXXXX"
    }, 
    {
      "barcode_id": "XXX", 
      "color": "XXX"
    },
    ...
  ]
}, 200

...