{"info":{"_postman_id":"13aa9001-2e24-48c9-bc02-49c59769ec74","name":"school management api","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"40107823","collectionId":"13aa9001-2e24-48c9-bc02-49c59769ec74","publishedId":"2sB2j1hso1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-04-28T09:34:54.000Z"},"item":[{"name":"post addschools","id":"1aee26e6-3f04-48ad-90c0-191332ba38e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"ABC High\",\r\n \"address\": \"123 Main St\",\r\n \"latitude\": 32.9988,\r\n \"longitude\": 90.7378\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:8000/api/schools/addschool","description":"

Add School

This endpoint allows you to add a new school to the database.

Request Body

name (string) : The name of the school.
\n
address (string) : The address of the school.
\n
latitude (number) : The latitude coordinate of the school location.
\n
longitude (number) : The longitude coordinate of the school location.
\n

Response

success (boolean) : Indicates if the request was successful.
\n
message (string) : A message related to the request.
\n
data (object) : An object containing the details of the added school, including the name, address, latitude, longitude, _id, createdAt, updatedAt, and __v.
\n

Example:

{\n    \"success\": true,\n    \"message\": \"\",\n    \"data\": {\n        \"name\": \"ABC High\",\n        \"address\": \"123 Main St\",\n        \"latitude\": 0,\n        \"longitude\": 0,\n        \"_id\": \"\",\n        \"createdAt\": \"\",\n        \"updatedAt\": \"\",\n        \"__v\": 0\n    }\n}\n\n

\n","urlObject":{"protocol":"http","port":"8000","path":["api","schools","addschool"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"1aee26e6-3f04-48ad-90c0-191332ba38e2"},{"name":"get all schools list","event":[{"listen":"test","script":{"id":"7f7effe7-5b86-4867-8ef4-2afcc7ed53a0","exec":[""],"type":"text/javascript","packages":{}}}],"id":"cb4e285c-c433-4e38-86f8-4e4e63ae77dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8000/api/schools/listSchools?latitude=32.98&longitude=90.73","description":"

This endpoint makes an HTTP GET request to retrieve a list of schools based on the provided latitude and longitude coordinates. The request should include the latitude and longitude query parameters in the URL.

Request

Method: GET
\n
URL: http://localhost:8000/api/schools/listSchools
\n
Query Parameters:
\n
- latitude (number): The latitude coordinate.
  \n
- longitude (number): The longitude coordinate.
  \n
\n

Response

Upon a successful execution, the endpoint returns a JSON response with a status code of 200 and the following structure:

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": [\n    {\n      \"_id\": \"\",\n      \"name\": \"\",\n      \"address\": \"\",\n      \"latitude\": 0,\n      \"longitude\": 0,\n      \"createdAt\": \"\",\n      \"updatedAt\": \"\",\n      \"__v\": 0,\n      \"distance\": 0\n    }\n  ]\n}\n\n

success (boolean): Indicates if the request was successful.
\n
message (string): An optional message related to the response.
\n
data (array): An array of school objects, each containing the following properties:
\n
- _id (string): The unique identifier of the school.
  \n
- name (string): The name of the school.
  \n
- address (string): The address of the school.
  \n
- latitude (number): The latitude coordinate of the school location.
  \n
- longitude (number): The longitude coordinate of the school location.
  \n
- createdAt (string): The timestamp of the school's creation.
  \n
- updatedAt (string): The timestamp of the school's last update.
  \n
- __v (number): Version key for the school object.
  \n
- distance (number): The distance of the school from the provided coordinates.
  \n
\n

\n","urlObject":{"protocol":"http","port":"8000","path":["api","schools","listSchools"],"host":["localhost"],"query":[{"key":"latitude","value":"32.98"},{"key":"longitude","value":"90.73"}],"variable":[]}},"response":[],"_postman_id":"cb4e285c-c433-4e38-86f8-4e4e63ae77dc"}]}