Versions Compared

Key

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

...

URL /api/sample/count_total
DescriptionReturn the total number of samples the user uploaded
HeaderAPI_KEY, Authorization
MethodGET
Url Param--
Request Body Data

--

Response

{ "sampleCount": int } - 200


Survey APIs

URL /api/sendAfterBirthSurvey
Descriptionsend the infant after birth qualtrics survey to the email specified
HeaderAPI_KEY, Authorization
MethodPOST
Url Param --
Request Body Data


Image Added


Response

{message: "Email is sent"} - 200

{message: "There was a problem sending the email. Please try again later"} - 500

URL /api/survey/questions
DescriptionReturns the sample survey when 'main_survey' is passed in as survey_name
HeaderAPI_KEY, Authorization
MethodGET
Url Param survey_name
Request Body Data

--

Response
Wiki Markup
{questionsList: [{
        "questionId": "questionDiet",
        "questionText": "Whatwasyourbaby'sdiettoday?",
        "questionType": "questionTypeSingleSelect",
        "responses": [
            {
                "responseId": "responsesDiet_exclusiveBreastFeeding",
                "responseText": "ExclusiveBreastFeeding"
            },
...
...
...
]}


...