Versions Compared

Key

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

...

URL /api/survey
DescriptionPlace a survey into the database in order to be retrieved by the application in the future
HeaderAPI_KEY, Authorization
MethodPUT
Url Paramsurvey_name
Request Body Data

Survey to placed in the database

Response
{
"message": "Incorrect API key provided."
}
{
"message": "Survey stored!"
}, 200
If survey name not passed in,
{
"message"="Please pass in survey name to create a survey"
}, 400
Sample


Upload APIs (

used for dashboard upload functionality, not for mobile

they are in the code, but neither mobile nor dashboard uses them)


URL /api/upload/
Description

GET: Fetching all uploaded species reads

PUT: Upload a species read

HeaderAPI_KEY, Authorization
Content-typeraw
MethodPUT | GET
Url Param

--

Request Body Data

GET

---

PUT

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

                ...
                }
}


Response

PUT

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


GET

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

                                ...
                         }
                },

                ...
         ],
         "num": XX
}


200: Success

...