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

User Authentication APIs

Sample APIs

URL	/api/samples/
Description	Fetching multiple Samples at the same time or Inserting a Sample. [Poop Sample Response]
Header	API_KEY, Authorization
Method	PUT \| GET
Url 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.

URL	/api/samples/
Description	Fetching multiple Samples at the same time or Inserting a Sample. [Poop Sample Response]
Header	API_KEY, Authorization
Method	PUT \| GET
Url 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.

URL	/api/samples/
Description	Fetching multiple Samples at the same time or Inserting a Sample. [Poop Sample Response]
Header	API_KEY, Authorization
Method	PUT \| GET
Url 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" } - 404 { message: "Bad request: no sample data"} - 404 { message: "Bad request: no barcode ID"} - 404 { message: "Bad request: no survey data"} - 404 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/sample/<sample_id>
Description	Fetching the image of a Specific Sample Response
Header	API_KEY, Authorization
Method	GET
Url Param	sample_id=[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” } 403: Unauthorized { 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>
Description	Fetching a Specific Sample Response
Header	API_KEY, Authorization
Method	GET
Url Param	barcode_id=[string]
Request Body Data	--
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” } 403: Unauthorized { message: ”No such sample exists” } 404: Resource Not Found

URL	/api/sample/<barcode_id>/image
Description	Fetching the image of a Specific Sample Response
Header	API_KEY, Authorization
Method	GET
Url Param	barcode_id=[string]
Request Body Data	--
Response	{ 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/count_total
Description	Return the total number the user uploaded
Header	API_KEY, Authorization
Method	GET
Url Param	--
Request Body Data	--
Response	{ "sampleCount": int } - 200