Versions Compared

Key

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

...

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": "0072140633868", 
      "color": "Rust Brown"
    },
...
]
}, 200


URL /api/stool-color/
Description

GET: Fetch all valid barcodes in MongoDB

MethodGET
Request Body Data


"Response
{
  "barcode_id": [
    "XXX1", 
    "XXX2", 
    "XXX3", 
...
]
}, 200