URL for

...

prod server: https://

...

mobile.diaper-project.

...

URL for prod server: https://on-prod.diaper.cf:5001

com

Notes:

The API key is just the API key.

Image Added

If the Header needs Authentification, please use the "user log in" API first, the response body will have "authToken," as shown in the below image. Copy it in to the header, and add "Bearer" in front of it.

Image Added

Server Info

...

APIs

...

URL

/api/

version

monitoring

Description

Show API Version

Monitoring related info
Method	GET
Url Param	--
Request Body Data	--
Response	{

version

api_env: "dev",

connected_db: "dev",

pipeline: "

xxx

mobile"

}

-

200

Cookie

--

URL

/api/

auth

version

Description

User login

Show API Version

Method

POST

GET
Url Param	--
Request Body Data

--

Response

{version: "xxx"} - 200

Cookie

--

...

User Creation APIs

URL

/api/

samples/

users

Description

Fetching multiple Samples at the same time or Inserting a Sample. [Poop Sample Response]

Create a new user
Method	PUT
Content-type	application/json

HeaderAPI_KEY, AuthorizationMethodPUT | GET


Url Param	---
Request Body Data

PUT

{

{ sampleData

email: xxx,

image

firstName: xxx

}

,

Note: SampleData should send as form-data text, and the image should be form-data file.

Response

PUT

{ message: “Sample data recorded!” } - 200: Success

{ message: "Bad request: no image or sample data" } - 400

{ message: "Bad request: no sample data"} - 401

{ message: "Bad request: no barcode ID"} - 402

{ message: "Bad request: no survey data"} - 403
GET
{ sampleList: [ { id: xxx, dateTime: xxx, hasPict: xxx, hasSurvey: xxx, hasContainer: xxx },
{ id: xxx, dateTime: xxx, hasPict: xxx, hasSurvey: xxx, hasContainer: xxx },
{}…..{} ] }
200: Success
Note[Limit]: Up to 15 samples can be retrieved at max.URL/api/samples/DescriptionFetching multiple Samples at the same time or Inserting a Sample. [Poop Sample Response]HeaderAPI_KEY, AuthorizationMethodPUT | GETUrl Param

--

Request Body Data

PUT
{ sampleData: xxx, image: xxx}

Note: SampleData should send as form-data text, and the image should be form-data file.

Response

PUT

{ message: “Sample data recorded!” } - 200: Success
{ message: "Bad request: no image or sample data" } - 400
{ message: "Bad request: no sample data"} - 401
{ message: "Bad request: no barcode ID"} - 402
{ message: "Bad request: no survey data"} - 403

GET
{ sampleList: [ { id: xxx, dateTime: xxx, hasPict: xxx, hasSurvey: xxx, hasContainer: xxx },
{ id: xxx, dateTime: xxx, hasPict: xxx, hasSurvey: xxx, hasContainer: xxx },
{}…..{} ] }
200: Success
Note[Limit]: Up to 15 samples can be retrieved at max.

lastName: xxx,

surveyData: xxx

}

Response

Response Body	Code
{ message: "Password set email has been sent." }	200
{ message: "Malformatted JSON" }	400
{ message: "There was a problem sending the password set email. Please try again later." }	500
{ message: "User already exists!" }	500

Cookie

---

...

User Authentication APIs

URL

/api/auth

Description

User login

Method

POST

Content-type

application/json

Url Param

--

Request Body Data

{

email: xxx,

password: xxx,

firstName: xxx,

lastName: xxx

}

Response

Response Body	Code
{ loginResponseType: “loginResponseTypeSuccess”, message: "User successfully authenticated.", accessToken: xxx, email: xxx, firstName: xxx, lastName: xxx }	201
{ loginResponseType: "loginResponseTypeInvalidPassword", message: "Failed login", displayMessage: "Incorrect email or password." }	401
{ message: "There was a problem sending the password set email. Please try again later" }	500
{ loginResponseType: "loginResponseTypePasswordNotSet", message: "User password has not been set.", displayMessage: "Please check your email for a link to set your account password." }

Cookie

---

URL

/api/users/<email>/resetpassword

Description

Reset password with given new password

Method

POST

Url Param

email: email for the user to reset password

Request Body Data

{

password: xxx

}

Note: password field takes the new password to be reset, not the old password.

Response

Response Body

Code

{

message: "Successfully updated password"

}

200

{

message: "Invalid email address provided"

}

400

{

message: "Unauthorized: you do not have access to reset this user's password"

}

401

Cookie

---

URL

/api/users/<email>/requestpasswordreset

Description

Send password reset email

Method

POST

Url Param

email: email for the user to reset password

Request Body Data

---

Response

Response Body

Code

{

message: "Password reset email has been sent."

}

200

{

message: "Invalid email address provided"

}

400

{

message: "There was a problem sending the password reset email. Please try again later"

}

500

Cookie

---

URL

/api/logout

Description

Log out user by deleting the user's access token

Method

DELETE

Url Param

---

Request Body Data

---

Response

Response Body

Code

{

message: "Successfully logged out"

}

200

Cookie

---

...

Sample APIs

URL	/api/samples/
Description

Fetching multiple Samples at the same time or Inserting a Sample.

GET: Fetching all samples created from a user PUT: Inserting a new sample [Poop Sample Response]
Header	API_KEY, Authorization
Content-type	multipart/form-data
Method	PUT \| GET
Url Param	--
Request Body Data	GET --- PUT { sampleData: { sampleBarcodeID: xxx, milkBarcodeID:xxx, surveyData: {...} }, image: xxx } Note: SampleData should send as form-data text, and the image should be form-data file.
Response	PUT { message: “Sample data recorded!” } - 200: Success { message: "Bad request: no image or sample data" } -

404

400
{ message: "Bad request: no sample data"} -

404

401
{ message: "Bad request: no barcode ID"} -

404

402
{ message: "Bad request: no survey data"} -

404

403

GET
{ sampleList: [

{

id:

xxx, dateTime: xxx, hasPict: xxx, hasSurvey: xxx, hasContainer: xxx },
{ id: xxx, dateTime: xxx, hasPict: xxx, hasSurvey: xxx, hasContainer: xxx },
{}…..{} ]

barcode id,

milk_id: milk id,

dateTime: timestamp,

surveyData: {},

readableSurveyData: {},

image_url: url of sample image,

email: xxx@gmail.com

},

{

...

},]

}
200: Success

Note[Limit]: Up to 15 samples can be retrieved at max.

~~URL~~	~~/api/sample/<sample_id>(deprecated)~~
~~Description~~	~~Fetching the image of a Specific Sample Response~~

URL	/api/sample/<barcode_id>
Description	Fetching a specific sample with barcode id
Header	API_KEY, Authorization
Method	GET
Url Param

sample_id=[string]

<barcode_id> : ID for the sample to update (string)

Request Body Data

PUT
{ sampleData: xxx, image: xxx}

Note: SampleData should send as form

-

data text, and the image should be form

-

data file.

Response

{ sample: { id: xxx, dateTime: xxx, hasPict: xxx, hasSurvey: xxx, hasContainer: xxx } }
200: Success

{ message:

”This user does not have access to this sample data”

”sample id is invalid” }

403

400:

Unauthorized

Invalid

{ message

: ”No such sample exists” }
404

:

Resource Not Found{ message:

”This user does not have access to this sample data” }
403: Unauthorized

{ message: ”No such sample exists” }
404: Resource Not Found

URL	/api/sample/

<barcode_id>

<barcode_id>/image
Description	Fetching

a Specific Sample Response

the image of a specific sample
Header	API_KEY, Authorization
Method	GET
Url Param

barcode_id=[string]

<barcode_id> : ID for the sample to update (string)
Request Body Data	--
Response

{ sample: { id: xxx, dateTime: xxx, hasPict: xxx, hasSurvey: xxx, hasContainer: xxx } }

image/png

200:

Success

Succeed

{ message: ”This user does not have access to this sample data” }
403: Unauthorized

{ message: ”No such sample exists” }
404: Resource Not Found

URL	/api/sample/count_this_week
Description	Return the total number the user uploaded this week
Header	API_KEY, Authorization
Method	GET
Url Param
Request Body Data	--
Response	{ "sampleCount": int } - 200

URL	/api/sample/<barcode_id>/

image

updatesurvey

Description

Fetching the image of a Specific Sample Response

Update survey for the given sample id
Content-Type	multipart/form-data
Header	API_KEY, Authorization
Method

GET

PUT

Url Param

barcode_id=[string]

<barcode_id> : ID for the sample to update (string)

Request Body Data

--

surveyData: list of new survey data
Response	{message:

”This user does not have access to this sample data” }
403: Unauthorized

"Bad request: no survey data to update"} - 404

{message:

”No such sample exists” }

"sample id is invalid"} - 400

{message: "successfully updated survey data"} - 200

404: Resource Not Found

URL	/api/sample/count_

this_week

total
Description	Return the total number of samples the user uploaded

this week


Header	API_KEY, Authorization
Method	GET
Url Param

--
Request Body Data	--
Response	{ "sampleCount": int } - 200

...

Survey APIs

URL

/api/

sample/count_total

sendAfterBirthSurvey

Description

Return the total number the user uploaded

send the infant after birth qualtrics survey to the email specified
Header	API_KEY, Authorization
Method

GET

POST
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

Description

Returns the sample survey when 'main_survey' is passed in as survey_name

Header

API_KEY, Authorization

Method

GET

Url Param

survey_name

Request Body Data

--

Response

unmigrated-wiki-markup

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

URL	/api/survey
Description	Place a survey into the database in order to be retrieved by the application in the future
Header	API_KEY, Authorization
Method	PUT
Url Param	survey_name
Request Body Data	Survey to placed in the database
Response	{ "message": "Incorrect API key provided." } { "

sampleCount

message":

int } - 200

"Survey stored!" }, 200 If survey name not passed in, { "message"="Please pass in survey name to create a survey" }, 400
Sample	Image Added

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version Current

Key

URL for

prod server: https://

mobile.diaper-project.

URL for prod server: https://on-prod.diaper.cf:5001

com

Notes:

Server Info

APIs

User Creation APIs

User Authentication APIs

Sample APIs

Survey APIs

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

URL for

prod server: https://

mobile.diaper-project.

URL for prod server: https://on-prod.diaper.cf:5001

com

Notes:

Server Info

APIs

User Creation APIs

User Authentication APIs

Sample APIs

Survey APIs