Versions Compared

Old Version 13

changes.mady.by.user user-0a866

Saved on

compared with

New Version 14

changes.mady.by.user user-0a866

Saved on

Key

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

The server ip-address:port is 

...

https://

...

dashboard-test.

...

diaper.

...

cf:5000

URL/api/login/
DescriptionLogin a user, and set cookie for authentication
MethodPOST
Url Param 
Request Body Data
  1. HTML Form Submission with fields:
    1. email (string)
    2. password (string)
    3. remember_me (optional boolean)
  2. Alternatively, you can manually add following fields in request body as a json format:
    1. email (string)
    2. password (string)
    3. remember_me (optional boolean)
    4. formdata (empty string)
Response
  • {message: "Logged in."} - 200
  • {message: "Bad request format"} - 400
  • {message: "invalid credential(s) provided, please check your credential(s) and try again"} - 400/401
Cookie
  • session: a cookie for trace login status
  • remember_token: a cookie for remember_me feature (only when logged in with remember_me set to true)

...

URL/api/registration/
DescriptionRegister a new user.
MethodPOST
Url Param 
Request Body Data
  1. HTML Form Submission with fields:
    1. email (string)
    2. username (string)
    3. password (string)
    4. password2 (string)
  2. Alternatively, you can manually add following fields in request body as a json format:
    1. email (string)
    2. username (string)
    3. password (string)
    4. password2 (string)
    5. formdata (!EMPTY! string)
Response
  • {message: "Registered, please login."} - 200
  • {message: "Data input is not valid, please try again"} - 400
Cookie 



URL/api/logout/
DescriptionLogout a user, set cookie/disable the token saved in cookie
MethodPOST
Url Param 
Request Body Data

 


Response
  • {message: "logged out"} - 200
Cookie
  • session: will be removed
  • remember_token: will be removed

...

URL/api/samples/
DescriptionAdd sample data to mongoDB
MethodPOST
Url Param 
Request Body Data

A json format data
{
"sample": {
"description": "test",
"image_url": "url",
"uploader": "uploader",
"sample_id": "0000",
"sample_type": "BS",
"infant_id": "00"
}
}

Response
  • {message: "Sample data recorded!"} - 200
  • {message: "Bad reques"} - 400
  • {message: "invalid credential(s) provided, please check your credential(s) and try again"} - 400/401

...

URL/api/samples/image/<barcode_id>
DescriptionGet sample image to mongoDB
MethodGET
Url Param barcode_id
Request Body Data 
Response
    • {message: "Bad barcode id"} -400
    • {message: "Bad Request"} - 400
    • {message: "No image data found for barcode {barcode_id}"} - 404
    • {message: "No sample found for barcode {barcode_id}"} - 404
    • image - 200


URL/api/samples/image/<barcode_id>
DescriptionAdd sample image to mongoDB
MethodPOST
Url Param barcode_id
Request Body Data

files: {

image: image

}

Response
    • {message: "Bad barcode id"} -400
    • {message: "Bad Request"} - 400
    • {message: "No sample found for barcode {barcode_id}"} - 404
    • {message: "No image uploaded, bad request"} - 400
    • {message: "image saved"} - 200


URL/api/samples/surey/<barcode_id>
DescriptionGet sample image to mongoDB
MethodGET
Url Param barcode_id
Request Body Data

{

data: survey

}

Response
  • {message: "Bad barcode id"} -400
  • {message: "Bad Request"} - 400
  • {message: "No sample found for barcode {barcode_id}"} - 404
  • {message: "No survey found in request body"} - 400
  • {message: "survey saved"} - 200


URL/api/samples/surey/<barcode_id>
DescriptionAdd sample image to mongoDB
MethodPOST
Url Param barcode_id
Request Body Data
 

Response
  • {message: "Bad barcode id"} -400
  • {message: "Bad Request"} - 400
  • {message: "No sample found for barcode {barcode_id}"} - 404
  • {message: "No survey found for barcode {barcode_id}"} - 404
  • survey_data - 200

 

 



URL/api/infant/
DescriptionAdd infant to db
MethodPOST
Url Param
 

Request Body Data HTML Form Submission with fields:
  1. description (string)
  2. infant_id (string)
  3. name (string)
Response

  • {message: "Infant created"} -200
    {message: "Internal Error, please try again"} - 500
    {message: "Data input is not valid, please try again"} - 400


URL/api/infant/<id>
DescriptionGet infant by id
MethodGET
Url Param infant_id
Request Body Data
 

Response
  • {message: "Infant does not exist"} -404

  • {
    'infant_id': infant.infant_id,
    'name': infant.name,
    'create_time': infant.create_time,
    'description': infant.description
    }, 200