SquareAPI DOCS - Community Trash Collection API
\nWelcome to SquareAPI, a RESTful API built with Django to support community-driven trash collection initiatives. SquareAPI enables communities to manage and monitor trash collection points efficiently. Through its endpoints, users can create, update, and track collection points, manage collection events, and access real-time data on trash collection status. Designed with scalability and ease of use in mind, SquareAPI serves as a practical tool for keeping neighborhoods clean and organized.
\nKey Features:
\nCollection Point Management: Add, edit, and view trash collection points on a map.
\nCommunity Participation: Facilitate volunteer tracking and community engagement in cleanup events.
\nReal-Time Tracking: Monitor trash collection activities and status updates.
\nGetting Started:
To access and use SquareAPI, set up your environment, clone the repository, and refer to our GitHub repository for installation and deployment guidelines.
NOTE: not all Endpoints have been included in this documentation!
\nMore Endpoints will be documented in the course of time.
\nFor any questions or support, please reach out to me. SquareAPI © 2024, released under the MIT License.
\n![](\"https://mrphilip.pythonanywhere.com/static/images/og.svg\")
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31401198","collectionId":"53845cd3-367e-421b-a2bf-26a4c2a47690","publishedId":"2sAY545dod","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-11T19:57:39.000Z"},"item":[{"name":"Register","id":"05975182-119e-48cd-8eff-dc6ae1078682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"{{vault:vname}}","type":"text"},{"key":"email","value":"{{vault:vname}}","type":"text"},{"key":"password","value":"{{vault:vpassword}}","type":"text"},{"key":"user_type","value":"normal","type":"text"}]},"url":"http://127.0.0.1:8000/users/register/","description":"The API endpoint http://127.0.0.1:8000/users/register/ is a POST request used to register new users. The request body should be of form-data type and include the following parameters:
name (text): The name of the user.
email (text): The email address of the user.
password (text): The password for the user's account.
user_type (text): The type of user account.
The response from the last execution of this request returned a JSON object with the following schema:
\n{\n \"id\": 0,\n \"name\": \"\",\n \"_id\": 0,\n \"isAdmin\": true,\n \"coname\": null,\n \"aname\": null,\n \"password\": \"\",\n \"last_login\": null,\n \"is_superuser\": true,\n \"username\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"is_staff\": true,\n \"is_active\": true,\n \"points\": 0,\n \"is_demo\": true,\n \"auth_provider\": \"\",\n \"email\": \"\",\n \"bio\": null,\n \"date_joined\": \"\",\n \"avi\": \"\",\n \"contact_number\": null,\n \"location\": null,\n \"user_type\": \"\",\n \"community\": null,\n \"area\": null,\n \"groups\": [],\n \"user_permissions\": []\n}\n\nThis JSON schema represents the structure of the response object, including the keys and their data types. Each key may have different data types such as boolean, string, number, or null.
\n","urlObject":{"path":["register",""],"host":["http://127.0.0.1:8000/users"],"query":[],"variable":[]}},"response":[],"_postman_id":"05975182-119e-48cd-8eff-dc6ae1078682"},{"name":"LOGIN","id":"812b8a3b-0917-4b4c-a923-a1fe4a2a4329","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"{{vault:vname}}","type":"text"},{"key":"password","value":"{{vault:vpassword}}","type":"text"}]},"url":"http://127.0.0.1:8000/users/login/","description":"This endpoint allows users to log in by providing their username and password.
\nusername (text): The username of the user.
password (text): The password of the user.
Status: 200
\nContent-Type: application/json
\n{\n \"refresh\": \"\",\n \"access\": \"\",\n \"id\": 0,\n \"_id\": 0,\n \"username\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"isAdmin\": true,\n \"is_demo\": true,\n \"bio\": null,\n \"user_type\": \"\",\n \"token\": \"\",\n \"expiration_time\": \"\"\n}\n\nThis endpoint retrieves a list of notices for the users.
\nThis is a GET request and does not require a request body.
\nThe response is a JSON object with the following schema:
\n{\n \"count\": integer,\n \"next\": string or null,\n \"previous\": string or null,\n \"results\": [\n {\n \"id\": integer,\n \"message\": string,\n \"created_at\": string,\n \"is_read\": boolean,\n \"user\": integer\n }\n ]\n}\n\ncount: The total number of notices.
next: URL for the next page of notices, or null if no next page.
previous: URL for the previous page of notices, or null if no previous page.
results: An array of notice objects containing the following fields:
id: The unique identifier for the notice.
message: The content of the notice message.
created_at: The timestamp when the notice was created.
is_read: A boolean indicating whether the notice has been read.
user: The user ID associated with the notice.
The response contains a JSON object with the list of notices, including their IDs, messages, creation timestamps, read status, and associated user IDs.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:squaretoken}}"}]},"isInherited":true,"source":{"_postman_id":"53845cd3-367e-421b-a2bf-26a4c2a47690","id":"53845cd3-367e-421b-a2bf-26a4c2a47690","name":"SQUARE API","type":"collection"}},"urlObject":{"path":["notices",""],"host":["http://127.0.0.1:8000/users"],"query":[],"variable":[]}},"response":[],"_postman_id":"6125bba5-2ac6-40d8-8635-d8eb6b81ef77"},{"name":"Trash Submission","id":"6731579b-f7a3-417c-9189-48afc7dc2c86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"trash_type\": \"plastic\",\r\n \"point\": 1\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/v1/trash/direct/","description":"This endpoint allows you to make an HTTP POST request to create a new entry for a trash item directly. The request should include the trash type and the point value.
\ntrash_type: The type of trash being added (e.g. plastic).
point: The point value associated with the trash item.
Upon successful creation, the endpoint returns a status code of 201 and a JSON response with the following fields:
\nphoto: (null) The photo of the trash item, if available.
point: (0) The point value associated with the trash item.
types: (\"\") Additional types of the trash item.
verification_status: (true) The verification status of the trash item.
timestamp: (\"\") The timestamp of the trash item creation.
This endpoint retrieves all trash data.
\nNo request body is required for this endpoint.
\nThe response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"count\": {\n \"type\": \"integer\"\n },\n \"next\": {\n \"type\": [\"string\", \"null\"]\n },\n \"previous\": {\n \"type\": [\"string\", \"null\"]\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"photo\": {\n \"type\": [\"string\", \"null\"]\n },\n \"point\": {\n \"type\": \"integer\"\n },\n \"types\": {\n \"type\": \"string\"\n },\n \"verification_status\": {\n \"type\": \"boolean\"\n },\n \"timestamp\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n\nThis endpoint allows the user to submit coordinates for processing.
\ncoordinates (text): The coordinates data in text format.Status: 200
\nContent-Type: application/json
\n{\n \"count\": 0,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 0,\n \"location\": \"\",\n \"estate\": \"\",\n \"types\": \"\",\n \"admin_area\": 0\n }\n ]\n}\n\nThe response contains the count of results and an array of point details including id, location, estate, types, and admin_area.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:squaretoken}}"}]},"isInherited":true,"source":{"_postman_id":"53845cd3-367e-421b-a2bf-26a4c2a47690","id":"53845cd3-367e-421b-a2bf-26a4c2a47690","name":"SQUARE API","type":"collection"}},"urlObject":{"path":["points",""],"host":["http://127.0.0.1:8000/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"0080a2a9-734d-45be-947d-8fbee5bf8214"},{"name":"List All Collection Administration Areas.","id":"151db9ee-09bd-4f6b-8855-9b2cf8474ada","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://127.0.0.1:8000/v1/admin-areas/","description":"This endpoint makes an HTTP GET request to fetch a list of admin areas.
\nThis request does not require a request body.
\nUpon a successful execution, the API returns a JSON response with the following fields:
\ncount (integer): The total count of admin areas.
next (string): The URL for the next page of results, if available.
previous (string): The URL for the previous page of results, if available.
results (array): An array of admin area objects, each containing the following fields:
id (integer): The unique identifier for the admin area.
aname (string): The admin area name.
name (string): The name of the admin area.
coordinates (string): The coordinates of the admin area.
main_coordinate (string): The main coordinate of the admin area.
admin (integer): The admin identifier associated with the admin area.
{\n \"count\": 0,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 0,\n \"aname\": \"\",\n \"name\": \"\",\n \"coordinates\": \"\",\n \"main_coordinate\": \"\",\n \"admin\": 0\n }\n ]\n}\n\nThis endpoint allows the user to join a community by providing their coordinates.
\ncoordinates (text): The user's coordinates.The response is in JSON format and includes the following fields:
\ndetail: Details about the join operation.
community: Information about the community joined.
{\n \"type\": \"object\",\n \"properties\": {\n \"detail\": {\"type\": \"string\"},\n \"community\": {\"type\": \"string\"}\n }\n}\n\nThe endpoint http://127.0.0.1:8000/v1/admin-areas/1/ makes an HTTP GET request to retrieve information about a specific admin area.
The response will be a JSON object with the following properties:
\nid (number): The ID of the admin area.
aname (string): The name of the admin area.
name (string): Another name associated with the admin area.
coordinates (string): The coordinates of the admin area.
main_coordinate (string): The main coordinate of the admin area.
admin (number): The admin status of the area.
Example:
\n{\n \"id\": 0,\n \"aname\": \"\",\n \"name\": \"\",\n \"coordinates\": \"\",\n \"main_coordinate\": \"\",\n \"admin\": 0\n}\n\nThe GET /v1/point/1/ endpoint retrieves information about a specific point. The response returned is a JSON object with the following schema:
{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n },\n \"location\": {\n \"type\": \"string\"\n },\n \"estate\": {\n \"type\": \"string\"\n },\n \"types\": {\n \"type\": \"string\"\n },\n \"admin_area\": {\n \"type\": \"integer\"\n }\n }\n}\n\n