APIs designed to simplify school operations by managing student records, classes, and staff information. Ideal for building applications that enhance administration and improve the learning experience.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29778371","collectionId":"f235f614-2754-4785-84d8-4dd9c6cb9b9a","publishedId":"2sAYBbf9xG","public":true,"customColor":{"top-bar":"FeF3E2","right-sidebar":"FAB12F","highlight":"FF6C37"},"publishDate":"2024-12-07T18:25:21.000Z"},"item":[{"name":"Get Students","id":"c8df7d90-48c2-4233-9311-de505b9fc911","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host-school2}}/students","description":"The endpoint makes an HTTP GET request to retrieve a list of students from the school. The response for this request is a JSON array containing objects with the following schema:
\n{\n \"_id\": \"string\",\n \"name\": \"string\",\n \"age\": \"number\",\n \"gender\": \"string\",\n \"marks\": \"number\",\n \"attendance\": \"array\",\n \"grade\": \"string\",\n \"__v\": \"number\"\n}\n\nThe POST request to /students endpoint is used to add a new student to the school database. The request should include the student's name, age, grade, gender, marks, and attendance.
name: (string) The name of the student.
age: (string) The age of the student.
grade: (string) The grade/class of the student.
gender: (string) The gender of the student.
marks: (string) The marks obtained by the student.
attendance: (string) The attendance status of the student.
The response to this request is a JSON object with the following schema:
\n{\n \"name\": \"\",\n \"age\": 0,\n \"gender\": \"\",\n \"marks\": 0,\n \"attendance\": [],\n \"grade\": \"\",\n \"_id\": \"\",\n \"__v\": 0\n}\n\nThe response includes the student's details such as name, age, gender, marks, attendance, grade, and other system-generated fields like _id and __v. The fields name, gender, and grade are of type string, age and marks are of type number, attendance is an array, and _id and __v are system-generated fields.
The endpoint updates the attendance of a specific student with the given ID. The request should be a PUT method to the endpoint \"{{host-school}}/students/6654c859f8545574da7dad4b\" with the following payload in raw request body type:
\n{\n \"attendance\": {\n \"status\": \"Present\",\n \"date\": \"2024-05-27\"\n }\n}\n\nThe response for this request follows the JSON schema below:
\n{\n \"_id\": \"\",\n \"name\": \"\",\n \"age\": 0,\n \"gender\": \"\",\n \"marks\": 0,\n \"attendance\": [\n {\n \"status\": \"\",\n \"date\": \"\",\n \"_id\": \"\"\n }\n ],\n \"grade\": \"\",\n \"__v\": 0\n}\n\nThis endpoint is used to update the details of a specific student.
\nThe request body should be in raw format with the following parameters:
\nname (string, required): The updated name of the student.
age (number, required): The updated age of the student.
Example:
\n{\n \"name\": \"Updated Name\",\n \"age\": 15\n}\n\nThe response for this request follows the JSON schema below:
\n{\n \"_id\": \"\",\n \"name\": \"\",\n \"age\": 0,\n \"gender\": \"\",\n \"marks\": 0,\n \"attendance\": [\n {\n \"status\": \"\",\n \"date\": \"\",\n \"_id\": \"\"\n }\n ],\n \"grade\": \"\",\n \"__v\": 0\n}\n\nThe HTTP DELETE request is used to delete a specific student with the given ID from the school database.
\nThe response will be in JSON format and will include the following fields:
\nmessage (string): A message indicating the outcome of the deletion process.
student (object): An object containing the details of the deleted student.
_id (string): The unique identifier of the student.
name (string): The name of the student.
age (number): The age of the student.
gender (string): The gender of the student.
marks (number): The marks obtained by the student.
attendance (array): An array containing the attendance records of the student.
grade (string): The grade of the student.
__v (number): Version control field.
This response can be used as a JSON schema to understand the structure of the data returned after deleting a student from the database.
\n","urlObject":{"path":["students","6654cb51f8545574da7dad53"],"host":["{{host-school}}"],"query":[],"variable":[]}},"response":[{"id":"ac7b4aa1-4682-4597-87fe-ee168a3e7923","name":"Delete Student","originalRequest":{"method":"DELETE","header":[],"url":"{{host-school}}/students/6654cb51f8545574da7dad53"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"173"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 27 May 2024 18:11:01 GMT"},{"key":"Etag","value":"W/\"ad-Ogzx32TV8GStNG76zh8F+vkQJcQ\""},{"key":"Replit-Cluster","value":"picard"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Robots-Tag","value":"none, noindex, noarchive, nofollow, nositelinkssearchbox, noimageindex"},{"key":"X-Robots-Tag","value":"none, noindex, noarchive, nofollow, nositelinkssearchbox, noimageindex"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Student deleted successfully\",\n \"student\": {\n \"_id\": \"6654cb51f8545574da7dad53\",\n \"name\": \"Ram\",\n \"age\": 13,\n \"gender\": \"Male\",\n \"marks\": 450,\n \"attendance\": [],\n \"grade\": \"9\",\n \"__v\": 0\n }\n}"}],"_postman_id":"2163eee0-e82f-4b24-b893-68622dd7c785"},{"name":"Get Student By Id","id":"b400262d-33e9-4929-ad24-581c8d97b518","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host-school}}/students/6654c859f8545574da7dad4b","description":"The endpoint retrieves information about a specific student identified by their unique ID. The response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": { \"type\": \"string\" },\n \"student\": {\n \"type\": \"object\",\n \"properties\": {\n \"_id\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"age\": { \"type\": \"integer\" },\n \"gender\": { \"type\": \"string\" },\n \"marks\": { \"type\": \"integer\" },\n \"attendance\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"status\": { \"type\": \"string\" },\n \"date\": { \"type\": \"string\" },\n \"_id\": { \"type\": \"string\" }\n }\n }\n },\n \"grade\": { \"type\": \"string\" },\n \"__v\": { \"type\": \"integer\" }\n }\n }\n }\n}\nThis endpoint sends an HTTP GET request to retrieve a list of teachers from the specified host. Below is the JSON schema for the response:
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"contactInformation\": {\n \"type\": \"object\",\n \"properties\": {\n \"email\": { \"type\": \"string\" },\n \"phoneNumber\": { \"type\": \"string\" }\n }\n },\n \"_id\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"subject\": { \"type\": \"string\" },\n \"__v\": { \"type\": \"number\" }\n }\n }\n}\n\nThe endpoint makes an HTTP POST request to {{host-school}}/teachers to add a new teacher. The request payload should be in raw JSON format and include the teacher's name, subject, and contact information with email and phone number.
\nname (string, required): The name of the teacher.
\nsubject (string, required): The subject taught by the teacher.
\ncontactInformation (object, required): The contact information of the teacher.
\nemail (string, required): The email address of the teacher.
\nphoneNumber (string, required): The phone number of the teacher.
\nThe response of this request is a JSON object with the following schema:
\n{\n \"name\": \"\",\n \"subject\": \"\",\n \"contactInformation\": {\n \"email\": \"\",\n \"phoneNumber\": \"\"\n },\n \"_id\": \"\",\n \"__v\": 0\n}\n\nThe response includes the teacher's name, subject, contact information with email and phone number, along with additional fields \"_id\" and \"__v\" which are specific to the system.
\n","urlObject":{"path":["teachers"],"host":["{{host-school}}"],"query":[],"variable":[]}},"response":[{"id":"a1ea8264-e598-42bc-93cd-5fe52529752e","name":"Create Teacher","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\" :\"Atmaram Bhide\",\n \"subject\":\"Maths\",\n \"contactInformation\": {\n \"email\" : \"ekamavsecretary@gmail.com\",\n \"phoneNumber\" :\"9875736212\"\n\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host-school}}/teachers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"142"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 27 May 2024 18:35:19 GMT"},{"key":"Etag","value":"W/\"8e-IHLBWD/5JjGJPUEFZlAAcO/joKQ\""},{"key":"Replit-Cluster","value":"picard"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Robots-Tag","value":"none, noindex, noarchive, nofollow, nositelinkssearchbox, noimageindex"},{"key":"X-Robots-Tag","value":"none, noindex, noarchive, nofollow, nositelinkssearchbox, noimageindex"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Atmaram Bhide\",\n \"subject\": \"Maths\",\n \"contactInformation\": {\n \"email\": \"ekamavsecretary@gmail.com\"\n },\n \"_id\": \"6654d266c563e55ec416469e\",\n \"__v\": 0\n}"},{"id":"0c8d352f-e25d-4e67-af02-c7305d9aec29","name":"Create Teacher","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\" :\"Atmaram Bhide\",\n \"subject\":\"Maths\",\n \"contactInformation\": {\n \"email\" : \"ekamavsecretary@gmail.com\",\n \"phoneNumber\" :\"9875736212\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host-school}}/teachers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"169"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 27 May 2024 18:40:05 GMT"},{"key":"Etag","value":"W/\"a9-vVXRNrNOvosmotW8hpXsdARMEik\""},{"key":"Replit-Cluster","value":"picard"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Robots-Tag","value":"none, noindex, noarchive, nofollow, nositelinkssearchbox, noimageindex"},{"key":"X-Robots-Tag","value":"none, noindex, noarchive, nofollow, nositelinkssearchbox, noimageindex"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Atmaram Bhide\",\n \"subject\": \"Maths\",\n \"contactInformation\": {\n \"email\": \"ekamavsecretary@gmail.com\",\n \"phoneNumber\": \"9875736212\"\n },\n \"_id\": \"6654d38534cbe05c1b4017e0\",\n \"__v\": 0\n}"}],"_postman_id":"3e7aeb35-fad8-410e-8365-2cfed41e9544"},{"name":"Update teacher","id":"9f3ac663-11c0-448a-8471-5f9a8fb6406c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contactInformation\": {\n \"email\" : \"ekamavsecretary@gmail.com\",\n \"phoneNumber\" :\"9875736212\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host-school}}/teachers/6654d266c563e55ec416469e","description":"This endpoint allows the client to update the information of a specific teacher.
\ncontactInformation (object)
email (string): The email address of the teacher.
phoneNumber (string): The phone number of the teacher.
The response for this request can be represented as a JSON schema:
\n{\n \"_id\": \"\",\n \"name\": \"\",\n \"age\": 0,\n \"gender\": \"\",\n \"marks\": 0,\n \"attendance\": [\n {\n \"status\": \"\",\n \"date\": \"\",\n \"_id\": \"\"\n }\n ],\n \"grade\": \"\",\n \"__v\": 0\n}\n\nThe endpoint sends an HTTP DELETE request to remove the teacher with the specified ID. Upon a successful deletion, the response will include a JSON object with the following schema:
\n{\n \"message\": \"string\",\n \"student\": {\n \"_id\": \"string\",\n \"name\": \"string\",\n \"age\": 0,\n \"gender\": \"string\",\n \"marks\": 0,\n \"attendance\": [],\n \"grade\": \"string\",\n \"__v\": 0\n }\n}\n\nThe endpoint makes an HTTP GET request to retrieve information about a specific teacher. The response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": { \"type\": \"string\" },\n \"teacher\": {\n \"type\": \"object\",\n \"properties\": {\n \"contactInformation\": {\n \"type\": \"object\",\n \"properties\": {\n \"email\": { \"type\": \"string\" },\n \"phoneNumber\": { \"type\": \"string\" }\n }\n },\n \"_id\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"subject\": { \"type\": \"string\" },\n \"__v\": { \"type\": \"number\" }\n }\n }\n }\n}\n\n