Versions Compared

Old Version 36

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

Saved on

compared with

New Version 37

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

Saved on

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


URL/api/

...

upload/
Description

GET: Fetching all uploaded csv files 

PUT: Upload a csv file 

HeaderAPI_KEY, Authorization
Content-typeraw
MethodPUT | GET
Url Param

...

--

Request Body Data

GET

---

PUT

{

        "file_name":"XXX",
        "barcode_id":["XXXXX", "XXXXXX"],
        "sample_id":["XXXX", "XXXX"],
        "sample_species_read": {
                "Actinotignum_timeonense": ["XX", "XX"],
                "Aeriscardovia_aeriphila": ["X", "X"]

                ...
                }
}


Response

PUT

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


 GET

{

{responseList: []}, 200

When an incorrect question ID is passed in:

{
"message": "Question ID is not found!"

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

                                ...
                         }
                },

                ...
         ],
         "num": 1
}


200: Success