{"info":{"_postman_id":"6e7bcf6a-1170-46f2-8d93-d67e03947b51","name":"school api","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"36192494","collectionId":"6e7bcf6a-1170-46f2-8d93-d67e03947b51","publishedId":"2sB3BKETje","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-08-19T17:06:21.000Z"},"item":[{"name":"create school","id":"d7537292-8faa-437a-b4c1-415a4d2d1aff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Christiansen - Muller School\",\n \"address\": \"7769 Osinski Bridge\",\n \"latitude\": 25.9409,\n \"longitude\": 22.2802\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/school","description":"

Add School

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

Request

Method: POST
Endpoint: {{URL}}/api/v1/school
Request Body (JSON):
- name (string): The name of the school.
- address (string): The physical address of the school.
- latitude (number): The geographical latitude of the school.
- longitude (number): The geographical longitude of the school.
\n

Response

Status Code: 201 Created
Content-Type: application/json
Response Body (JSON):
- status (string): The status of the response.
- data (object): Contains the details of the created school.
  - id (number): The unique identifier for the newly created school.
  - createdAt (string): The timestamp when the school was created.
  - name (string): The name of the school.
  - address (string): The address of the school.
  - latitude (number): The latitude of the school.
  - longitude (number): The longitude of the school.
  \n
- timestamp (string): The timestamp of the response.
\n

Notes

Ensure that all parameters are provided in the correct format to successfully create a new school entry.

\n","urlObject":{"path":["api","v1","school"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d7537292-8faa-437a-b4c1-415a4d2d1aff"},{"name":"get all schools","id":"98205c77-1e21-4f6c-8001-2b584cb83768","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/api/v1/school?userLat=25&sortBy=distance&userLng=26&sortOrder=desc&limit=10&offset=50","description":"

API Endpoint: Get Schools

This endpoint retrieves a list of schools based on the user's geographical location and specified sorting preferences. It allows users to find schools near them, sorted by distance.

Request Parameters

userLat (required, numeric): The latitude of the user's location.
userLng (required, numeric): The longitude of the user's location.
sortBy (optional, string): The parameter by which to sort the results. In this case, it is set to distance.
sortOrder (optional, string): The order of sorting. It can be either asc for ascending or desc for descending. The default here is desc.
limit (optional, numeric): The maximum number of results to return. This limits the response to a specified number of schools.
offset (optional, numeric): The number of results to skip before starting to collect the results. This is useful for pagination.

Response Structure

The response will be in JSON format and includes the following fields:

status: A string indicating the status of the request.
limit: The number of results requested (as specified in the request).
offset: The number of results skipped (as specified in the request).
total: The total number of schools available based on the query parameters.
data: An array of school objects, each containing:
- id: A unique identifier for the school.
- name: The name of the school.
- address: The physical address of the school.
- latitude: The latitude coordinate of the school.
- longitude: The longitude coordinate of the school.
- distance: The distance from the user's location to the school.
\n
timestamp: A string representing the time at which the response was generated.

Example Response

{\n  \"status\": \"\",\n  \"limit\": 0,\n  \"offset\": 0,\n  \"total\": 0,\n  \"data\": [\n    {\n      \"id\": 0,\n      \"name\": \"\",\n      \"address\": \"\",\n      \"latitude\": 0,\n      \"longitude\": 0,\n      \"distance\": 0\n    }\n  ],\n  \"timestamp\": \"\"\n}\n

This response indicates the status of the request and provides detailed information about the schools retrieved based on the user's location and sorting preferences.

\n","urlObject":{"path":["api","v1","school"],"host":["{{URL}}"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"userLat","value":"25"},{"key":"sortBy","value":"distance"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"userLng","value":"26"},{"key":"sortOrder","value":"desc"},{"key":"limit","value":"10"},{"key":"offset","value":"50"}],"variable":[]}},"response":[],"_postman_id":"98205c77-1e21-4f6c-8001-2b584cb83768"},{"name":"get all todo","id":"49dd685b-66fe-429e-bb89-ce622dcd8536","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"49dd685b-66fe-429e-bb89-ce622dcd8536"},{"name":"get single todo","id":"004c92fc-8924-462e-8edc-765ec34f3521","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"004c92fc-8924-462e-8edc-765ec34f3521"},{"name":"get all todo fb","id":"032b4187-f2be-413a-9f75-1be4d50e14bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"task\": \"this is the second task \",\n \"done\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/todo","urlObject":{"path":["api","v1","todo"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"032b4187-f2be-413a-9f75-1be4d50e14bd"},{"name":"update document","id":"a727d047-7aa4-48f5-a3f0-c551d33f0b1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"task\": \"this is test change \"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/todo/h2eb269BVR222BFMYCef","urlObject":{"path":["api","v1","todo","h2eb269BVR222BFMYCef"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a727d047-7aa4-48f5-a3f0-c551d33f0b1b"},{"name":"New Request","id":"120ba2c6-1642-4a87-9e0d-3a7ea66bef51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"task\": \"this is test change \"\n}"},"url":"{{URL}}/api/v1/todo/h2eb269BVR222BFMYCef","urlObject":{"path":["api","v1","todo","h2eb269BVR222BFMYCef"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"120ba2c6-1642-4a87-9e0d-3a7ea66bef51"},{"name":"New Request","id":"c3d07dd5-fe87-454a-8cf0-5a50008552ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"bookName\": \"test name hello\",\n \"bookCost\": 2000,\n \"description\": \"this is the test data\",\n \"author\": \"rajwinder singh\"\n }","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/library","urlObject":{"path":["api","v1","library"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3d07dd5-fe87-454a-8cf0-5a50008552ad"}]}