{"info":{"_postman_id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","name":"Doc","description":"

This api is not fully functional as features would be added with respect to time and however all current functionalities might have bugs and I'll try my best to debug, as the api would be tested.

URI and Versioning

We hope to improve the API over time. The changes won't always be backward compatible, so we're going to use versioning. This first iteration will have URIs prefixed with https://url/v0/ and is structured as described below. There is currently no rate limit.

Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description	Misc
`E000`	Bad Request
`E001`	Insufficient Parameters,
`E002`	An error occured, Make sure all fields are input correctly
`E004`	Login or Signup
`E005`	SignUp Error
`E006`	Email or Password is incorrent
`E007`	User Cannot Edit Profile
`E008`	User Cannot Delete Profile
`E009`	User Does Not Exist
`E010`	User Cannot Edit Item
`E011`	User Cannot Delete Item
`E012`	Item Does Not Exist
`E013`	Exceeded Maximum Number Of Uploads
`E014`	Image Not Found
`E016`	Email Already Exists
`E017`	Incorrect Password
`E018`	Email Doesn't Exists
`E019`	Expired Token (Request another one)

Regular Expressions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	REGEX	Misc
`NAME`	\"[A-Za-z0-9_]+\\s[A-Za-z0-9_]+\"
`EMAIL`	[^@ \\t\\r\\n]+@[^@ \\t\\r\\n]+.[^@ \\t\\r\\n]+
`PASSWORD`	^(?=.?[A-Z])(?=.?[a-z])(?=.?[0-9])(?=.?[#?!@$ %^&*-]).{8,}$

General Response Format

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

KEY	TYPE	Misc
`status_code`	Int
`data`	JSON Objest
`error_code`	String
`has_error`	Boolean
`description`	String
`error_data`	JSON Object

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14039622","collectionId":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","publishedId":"TzeTKVio","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-06-13T15:47:56.000Z"},"item":[{"name":"Auth","item":[{"name":"Login","id":"ff143636-bdad-456e-99a4-809605ef2aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"text2@gmail.com\",\r\n \"password\" : \"@Password78\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:5000/v0/login","description":"

This request would handle Authentication for avaliable users/patients/doctors.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

QUERY PARAMETER	TYPE	REQUIRED	REGEX
`email`	String	Required	None
`password`	String	Required	None

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is \"data\" and whose value is a dictionary or a JSON object which has a key access_token and value is a token which would be a valid Authentication header.

access_token would be used to authenticate the user/retailer/business-owner. However this should be set as the bearer-token where needed.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","name":"Doc","type":"collection"}},"urlObject":{"protocol":"http","port":"5000","path":["v0","login"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff143636-bdad-456e-99a4-809605ef2aee"},{"name":"Sign Up","id":"b281c70e-fc10-4b77-8c82-3478724879df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"Kenneth Gabriel\",\r\n \"email\" : \"text2@gmail.com\",\r\n \"password\" : \"@Password78\",\r\n \"is_doctor\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:5000/v0/signup","description":"

This request would handle Signing Up of new users/patients/doctors.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

QUERY PARAMETER	TYPE	REQUIRED	REGEX
`name`	String	Required	None
`email`	String	Required	None
`password`	String	Required	None
`is_doctor`	Boolean	Required	None

Response

access_token would be used to authenticate the user/retailer/business-owner. However this should be set as the bearer-token where needed.

This is said to be the back bone of Authentication as the request here would handle both /login and /signup request and here the Authorization Header or Access Token would be generated.

Possible Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description	Misc
`E004`	SignUp Error
`E005`	Login Error
`E006`	Email or Password is incorrent
`E016`	Email Already Exists

","_postman_id":"50aed348-3626-4fcb-9df8-55505629c766","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","name":"Doc","type":"collection"}}},{"name":"User","item":[{"name":"Get User /v0/users/","id":"00dd7eca-1504-4059-9cea-8f75f988f7b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"127.0.0.1:5000/v0/users/5595ac1b995d02c208f7bd9e93be4188","description":"

Here you'll get the details/data of any user with the provided <string:user_public_id>

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

PATH PARAMETER	TYPE	REQUIRED	REGEX
`user_public_id`	String	Required	None

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is \"data\" and whose value is a user object in JSON format.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","name":"Doc","type":"collection"}},"urlObject":{"port":"5000","path":["v0","users","5595ac1b995d02c208f7bd9e93be4188"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"00dd7eca-1504-4059-9cea-8f75f988f7b6"},{"name":"Edit Profile /v0/users","id":"d214a42b-63de-4f84-96ac-a76937c3b323","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"New Name\",\r\n \"email\" : \"new@email.com\",\r\n \"description\" : \"New description\"\r\n}","options":{"raw":{"language":"json"}}},"url":"127.0.0.1:5000/v0/users","description":"

You can edit a users data here. However the fields provided will be the fields that would be edited/updates

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HEADER	TYPE	REQUIRED
`Authorization`	String	Required

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

QUERY PARAMETER	TYPE	REQUIRED	REGEX
`name`	String	Required	NAME
`email`	String	Required	URL
`description`	String	Required	None

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is \"data\" and whose value is a user object in JSON format.

\n","urlObject":{"port":"5000","path":["v0","users"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"d214a42b-63de-4f84-96ac-a76937c3b323"}],"id":"8a0a048e-2a91-4215-8c91-b0edc60a6b21","description":"

All request here would handle the Getting of a user detailes, Editing of a user's data and Deleting of a user

Possible Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description	Misc
`E000`	Bad Request
`E021`	User Cannot Edit Profile
`E022`	User Cannot Delete Profile
`E023`	User Does Not Exist

User Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

KEY	TYPE	AUTHENTICATION
`public_id`	String
`email`	String	Required
`name`	String
`bio`	String
`is_doctor`	Boolean
`reports`	Array[Reports]
`replies`	Array[Replies]
`profile_photo`	String(Filename)
`joined`	Date

Note: The fields email would only be returned if the current user is authenticated and the is the same with the user requested

\n","_postman_id":"8a0a048e-2a91-4215-8c91-b0edc60a6b21","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","name":"Doc","type":"collection"}}},{"name":"Report","item":[{"name":"Get Report /v0/reports/","id":"1ec3ac78-ed52-4f98-8a23-fcf6ccd03e82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"127.0.0.1:5000/v0/reports/872d9a3150524e4a16be312f42fa4ab9","description":"

Here you'll get the details/data of any report with the provided <string:report_public_id>

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

PATH PARAMETER	TYPE	REQUIRED	REGEX
`report_public_id`	String	Required	None

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is \"data\" and whose value is a report object in JSON format.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","name":"Doc","type":"collection"}},"urlObject":{"port":"5000","path":["v0","reports","872d9a3150524e4a16be312f42fa4ab9"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ec3ac78-ed52-4f98-8a23-fcf6ccd03e82"},{"name":"Create Report /v0/reports","id":"21e29cd1-595b-4fcd-80f1-b219e7b406fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"content\" : \"My first issue\"\r\n}","options":{"raw":{"language":"json"}}},"url":"127.0.0.1:5000/v0/reports","description":"

Creates a new report

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HEADER	TYPE	REQUIRED
`Authorization`	String	Required

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

QUERY PARAMETER	TYPE	REQUIRED	REGEX
`content`	String	Required	None

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is \"data\" and whose value is a report object in JSON format.

\n","urlObject":{"port":"5000","path":["v0","reports"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"21e29cd1-595b-4fcd-80f1-b219e7b406fb"},{"name":"Edit Report /v0/reports/","id":"b08c2013-b353-490c-b5ca-8e7f71eb159b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"content\" : \"New issue content\"\r\n}","options":{"raw":{"language":"json"}}},"url":"127.0.0.1:5000/v0/reports/872d9a3150524e4a16be312f42fa4ab9","description":"

Edit a reports' data

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HEADER	TYPE	REQUIRED
`Authorization`	String	Required

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

PATH PARAMETER	TYPE	REQUIRED	REGEX
`report_public_id`	String	Required	None

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

QUERY PARAMETER	TYPE	REQUIRED	REGEX
`content`	String	Required	None

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is \"data\" and whose value is a report object in JSON format.

\n","urlObject":{"port":"5000","path":["v0","reports","872d9a3150524e4a16be312f42fa4ab9"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"b08c2013-b353-490c-b5ca-8e7f71eb159b"}],"id":"882462dc-e54f-4955-a531-321ff6c28904","description":"

All request here would handle the Getting of a report detailes, Editing of a report's data and Deleting of a report

Possible Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description	Misc
`E000`	Bad Request
`E010`	User Cannot Edit Post
`E011`	User Cannot Delete Post
`E012`	Item Does Not Exist

Report Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

KEY	TYPE	AUTHENTICATION
`public_id`	String
`content`	String
`created_at`	Date
`replies`	Array[Reply Object]
`author`	[User Object]

","_postman_id":"882462dc-e54f-4955-a531-321ff6c28904","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","name":"Doc","type":"collection"}}},{"name":"Reply","item":[{"name":"Get Reply /v0/replies/","id":"c37c91d6-af95-400d-9115-0a367967503a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"127.0.0.1:5000/v0/replies/703aa134631e0e3b935ee73494ae0f15","description":"

Here you'll get the details/data of any report with the provided <string:reply_public_id>

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

PATH PARAMETER	TYPE	REQUIRED	REGEX
`reply_public_id`	String	Required	None

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is \"data\" and whose value is a reply object in JSON format.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","name":"Doc","type":"collection"}},"urlObject":{"port":"5000","path":["v0","replies","703aa134631e0e3b935ee73494ae0f15"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"c37c91d6-af95-400d-9115-0a367967503a"},{"name":"Create Reply /v0/replies","id":"9ec0708c-047b-4965-93a3-8faea8a53bbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"content\" : \"Reply to report\",\r\n \"report_public_id\" : \"872d9a3150524e4a16be312f42fa4ab9\"\r\n}","options":{"raw":{"language":"json"}}},"url":"127.0.0.1:5000/v0/replies","description":"

Creates a new reply

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HEADER	TYPE	REQUIRED
`Authorization`	String	Required

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

QUERY PARAMETER	TYPE	REQUIRED	REGEX
`content`	String	Required	None
`report_public_id`	String	Required	None

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is \"data\" and whose value is a reply object in JSON format.

\n","urlObject":{"port":"5000","path":["v0","replies"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ec0708c-047b-4965-93a3-8faea8a53bbe"},{"name":"Edit Reply /v0/replies/","id":"c6ab6783-b5d1-4900-8b78-23676c532885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"content\" : \"New reply content\"\r\n}","options":{"raw":{"language":"json"}}},"url":"127.0.0.1:5000/v0/replies/703aa134631e0e3b935ee73494ae0f15","description":"

Edit a reply's data

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HEADER	TYPE	REQUIRED
`Authorization`	String	Required

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

PATH PARAMETER	TYPE	REQUIRED	REGEX
`reply_public_id`	String	Required	None

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

QUERY PARAMETER	TYPE	REQUIRED	REGEX
`content`	String	Required	None

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is \"data\" and whose value is a reply object in JSON format.

All request here would handle the Getting of a reply detailes, Editing of a reply's data and Deleting of a reply

Possible Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description	Misc
`E000`	Bad Request
`E010`	User Cannot Edit Post
`E011`	User Cannot Delete Post
`E012`	Item Does Not Exist

Reply Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

KEY	TYPE	AUTHENTICATION
`public_id`	String
`content`	String
`created_at`	Date
`author`	[User Object]

","_postman_id":"d1ee8567-fd63-4061-87f8-83654d489456","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","id":"34e7f07b-4d6b-4dc9-aa93-6bbff21143dd","name":"Doc","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"bd94d5c6-33f5-4735-b375-7b166eb1a836"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d29f8821-e264-4f97-9f1b-3df1f114ae05"}}]}