{"info":{"_postman_id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","name":"Notive Flask API","description":"

This API uses Bearer Authorization in all of its requests. You need to include the \"Authorization: Bearer \" in the request header. The token is specified as an environment variable and should never be published.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5446795","collectionId":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","publishedId":"SzKWtcso","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-02-25T09:58:09.000Z"},"item":[{"name":"Auth","item":[{"name":"Register New User","id":"e99a7d9c-3fe5-418f-827b-6c51def181a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"winstonUK\",\n\t\"password\": \"victory44\",\n\t\"email\": \"winston@churchill.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{req_url}}/auth/register","description":"

This endpoint creates a new user in the database with the given information.

This endpoint checks if the user exists and will log in the user to the system. A request must be to this end point prior to all other requests which use the 'login_required' tag.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","name":"Notive Flask API","type":"collection"}},"urlObject":{"path":["auth","login"],"host":["{{req_url}}"],"query":[],"variable":[]}},"response":[{"id":"77da02cd-ad12-434b-9c7b-d783048d9c45","name":"Login User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"password\": \"victory44\",\n\t\"email\": \"winston@churchill.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{req_url}}/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"220"},{"key":"Vary","value":"Cookie"},{"key":"Set-Cookie","value":"session=eyJ1c2VyX2lkIjo3fQ.XlTZfQ.rsGcornuLdT9cMTb5-767dTs26E; HttpOnly; Path=/"},{"key":"Server","value":"Werkzeug/0.16.1 Python/3.7.3"},{"key":"Date","value":"Tue, 25 Feb 2020 08:23:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"user\": {\n \"created_at\": 1582618977,\n \"email\": \"winston@churchill.com\",\n \"id\": 7,\n \"name\": \"winstonUK\"\n }\n },\n \"message\": \"You have been logged in successfully!\"\n}"}],"_postman_id":"ec0c6086-4901-46b7-b3ea-da839c42d9c9"},{"name":"Update User Password","id":"6f4edbfe-a479-45f1-b399-83d2d06aacdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"winston@churchill.com\",\n\t\"password\": \"maggie\"\n}","options":{"raw":{"language":"json"}}},"url":"{{req_url}}/auth/update_password","description":"

This endpoint takes the user e-mail address and the given plain password to update the user password.

This request will provide the necessary Client ID and Client Secret for Foursquare requests.

This endpoint requires no body and response will include all list information related to the user logged-in.

This endpoint takes a name parameter and will change the list name to the given name data. The ID of newly created list will be returned in the response.

This endpoint requires the list ID to be stated in the request URL and request body requires a provided name value. The list name will be updated accordingly.

This endpoint requires the list ID to be provided within the request URL.

If the list does not belong to the user or if the list does not exist, request will be ignored and will respond with an error code.

If the provided list ID belongs to the logged-in user's list, the list will be deleted. This action is not revertable.

Toggles the archive mode for given list.

Toggles the mute mode for given list.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","name":"Notive Flask API","type":"collection"}},"urlObject":{"path":["list","{{list_id}}","mute"],"host":["{{req_url}}"],"query":[],"variable":[]}},"response":[{"id":"1d67096a-3614-4f4a-b8a4-56320071d01d","name":"Mute List","originalRequest":{"method":"PUT","header":[],"url":"{{req_url}}/list/{{list_id}}/mute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"29"},{"key":"Vary","value":"Cookie"},{"key":"Server","value":"Werkzeug/0.16.1 Python/3.7.6"},{"key":"Date","value":"Sun, 29 Mar 2020 12:09:30 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"List is muted.\"\n}"},{"id":"c8172306-9ce0-49bc-84ff-3ac7a2562536","name":"Mute List","originalRequest":{"method":"PUT","header":[],"url":"{{req_url}}/list/{{list_id}}/mute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"31"},{"key":"Vary","value":"Cookie"},{"key":"Server","value":"Werkzeug/0.16.1 Python/3.7.6"},{"key":"Date","value":"Sun, 29 Mar 2020 12:12:23 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"List is unmuted.\"\n}"}],"_postman_id":"1e1b05f4-ae58-4ccc-aa98-4bc9dbc26606"}],"id":"c0c0d81c-e82b-4316-9bd8-4df85bec9b45","_postman_id":"c0c0d81c-e82b-4316-9bd8-4df85bec9b45","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","name":"Notive Flask API","type":"collection"}}},{"name":"Item","item":[{"name":"Get Singular List Item","id":"680c7508-cbcd-4616-8728-fc24ac7e976a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{req_url}}/item/{{list_id}}/{{item_id}}","description":"

A list ID and item ID must be provided within the request URL.

If the IDs provided do not match or belong to any of the logged-in user's lists & items, the request will be ignored and will respond with an error code.

If the request is successful, the response will include the singular item detail.

A list ID must be provided within the request URL.

If the ID provided does not exist or does not belong to any of the logged-in user's lists, the request will be ignored and will respond with an error code.

If the request is successful, the response will include all the item details of the requested list.

The response will include all the item details of the the logged-in user.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","name":"Notive Flask API","type":"collection"}},"urlObject":{"path":["item"],"host":["{{req_url}}"],"query":[],"variable":[]}},"response":[{"id":"b7d42ae6-9251-4571-969b-e44b8ab38f1e","name":"Get All Items Of User","originalRequest":{"method":"GET","header":[],"url":"{{req_url}}/item"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"386"},{"key":"Vary","value":"Cookie"},{"key":"Server","value":"Werkzeug/0.16.1 Python/3.7.3"},{"key":"Date","value":"Tue, 25 Feb 2020 09:32:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"items\": [\n {\n \"created_at\": 1582619296,\n \"finished_at\": null,\n \"id\": 5,\n \"is_done\": 0,\n \"list_id\": 6,\n \"name\": \"We shall fight on the beaches!\"\n },\n {\n \"created_at\": 1582619332,\n \"finished_at\": null,\n \"id\": 6,\n \"is_done\": 0,\n \"list_id\": 6,\n \"name\": \"We shall fight on the streets!\"\n },\n {\n \"created_at\": 1582623161,\n \"finished_at\": null,\n \"id\": 7,\n \"is_done\": 0,\n \"list_id\": 7,\n \"name\": \"We shall travel to France!\"\n }\n ]\n },\n \"message\": \"Success!\"\n}"}],"_postman_id":"9745f0fc-41aa-4bbb-ba9e-97773b67a95f"},{"name":"Add List Item","id":"fed3e514-d8ea-4ff5-9746-0bdb54286fd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"We shall fight on the beaches!\",\n\t\"list_id\": 8\n}","options":{"raw":{"language":"json"}}},"url":"{{req_url}}/item","description":"

'name' and 'list_id' information must be provided within the request body.

If the list ID provided does not exist or does not belong to any of the logged-in user's lists, the request will be ignored and will respond with an error code.

On success, a new item with provided name will be generated and will be associated to the list that matches the list ID.

This request changes the list item with given list ID and item ID to the provided item name.

If any of the ID provided does not exist or does not belong to any of the logged-in user's lists or items, the request will be ignored and will respond with an error code.

On success, item's name will be changed.

This requests deletes the item associated with the provided list ID and item ID in the request body.

If any of the ID provided does not exist or does not belong to any of the logged-in user's lists or items, the request will be ignored and will respond with an error code.

On success, the list item will be deleted. This action is not revertable.

List ID and Item ID must be stated within the request URL. On success, this will toggle the item's completion status and update its completion date accordingly.

If any of the ID provided does not exist or does not belong to any of the logged-in user's lists or items, the request will be ignored and will respond with an error code.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","name":"Notive Flask API","type":"collection"}},"urlObject":{"path":["item","{{list_id}}","{{item_id}}","check"],"host":["{{req_url}}"],"query":[],"variable":[]}},"response":[{"id":"1a6ba600-2ee0-4183-8998-fb49d598ac2e","name":"Check Item Incomplete","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{req_url}}/item/{{list_id}}/{{item_id}}/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"47"},{"key":"Vary","value":"Cookie"},{"key":"Server","value":"Werkzeug/0.16.1 Python/3.7.3"},{"key":"Date","value":"Tue, 25 Feb 2020 09:47:14 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item is marked as not completed!\"\n}"},{"id":"ffb0053c-cbf6-4972-8d77-c470a175acfc","name":"Check Item Completed","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{req_url}}/item/{{list_id}}/{{item_id}}/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"42"},{"key":"Vary","value":"Cookie"},{"key":"Server","value":"Werkzeug/0.16.1 Python/3.7.3"},{"key":"Date","value":"Tue, 25 Feb 2020 09:56:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item is marked as complete!\"\n}"}],"_postman_id":"a3db94c7-823a-4e08-a869-773477c99433"}],"id":"5fede3b2-df98-4ece-8403-3ed2f01c5051","_postman_id":"5fede3b2-df98-4ece-8403-3ed2f01c5051","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","id":"a2acc961-28ba-4e33-9ff3-7762b3e9d38e","name":"Notive Flask API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"eae45138-7b3f-45ad-ac91-db037b1fdddf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"557746f4-2dd8-43cb-929f-c4616b29f9df","type":"text/javascript","exec":[""]}}],"variable":[{"id":"ac573cee-e702-47dd-b898-a7805c3db608","key":"Auth-Key","value":"","type":"string"}]}