This API collection provides a set of endpoints and functionalities for student and teacher management. Designed to be user-friendly and secure, the collection allows developers to integrate these features into their applications seamlessly. Each API endpoint is documented with clear descriptions and response handling for ease of use.
\nAll API endpoints should be made to the following base URL:
\nPlain Text
\nhttps://school-management-backend.niharika2018.repl.co\n\nStudent Management:
\nGET /students: Retrieves a list of all students.POST /students: This adds a new student with details like name, age, grade, gender, attendance, marks, and class.PUT /students/:studentId: This updates a student by providing their ID and updated details.DELETE /students/:studentId: This deletes a student by providing its ID.GET /students/:studentName: This gives a student's details by providing their name.Teacher Management:
\nGET /teachers: Retrieves a list of all teachers.POST /teachers: This adds a new teacher with details like name, subject, and contact.PUT /teachers/:teacherId: This updates a teacher by providing their ID and updated details.DELETE /teachers/:teacherId: This deletes a teacher by providing its ID.GET /teachers/:teacherName: This gives a teacher's details by providing their name.Each API in this collection is designed to handle errors gracefully. They provide meaningful error messages and appropriate HTTP status codes to assist developers in troubleshooting and debugging.
\nEach API endpoint is well-documented, clearly describing its purpose, expected request payloads, and response formats. This documentation makes it easy for developers to integrate and use these APIs in their applications.
\nThis API collection can be used to build various applications. It provides essential tracker management and interaction features, enhancing the application's user experience and engagement.
\nWhether building a new application or enhancing an existing one, this API collection offers a solid foundation for tracking-related functionalities, saving development time, and ensuring a secure user experience.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16735195","collectionId":"55ee0fd3-d7eb-47bf-99f2-7d2a13410d44","publishedId":"2s9YR85DfU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-10-17T17:52:09.000Z"},"item":[{"name":"Student Management","item":[{"name":"Get All Students","id":"69ac52fb-3f9c-4cac-a1e5-8dd0afe8f9d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://school-management-backend.niharika2018.repl.co/students","description":"Title: Get All Students
\nDescription:
This request retrieves a list of all students in the inventory. It returns
an array of student objects containing the student's name, age, grade, gender, attendance, marks, and class.
Parameters:
None.
Returns:
An array of student objects.
Title: Add a Student
\nDescription:
This request saves new student data in the inventory. It accepts JSON data with student details and returns the created student object with its unique ID, name, age, grade, gender, attendance, marks, and class.
Parameters:
JSON object containing name, age, grade, gender, attendance, marks, and class.
Returns:
The newly added student object (has a unique ID, name, age, grade, gender, attendance, marks, and class)
Title: Update a Student
\nDescription:
This request updates existing student data in the inventory. It accepts studentId as params and JSON data with the student's new details and returns the updated student object with its unique ID, name, age, grade, gender, attendance, marks, and class.
Parameters:
studentId as params and JSON object containing new details of the student.
Returns:
The updated student object (has a unique ID, name, age, grade, gender, attendance, marks, and class)
Title: Delete a Student
\nDescription:
\nThis request deletes a student from the inventory. It accepts a student's ID as query params and returns the deleted student object containing fields like name, age, grade, gender, attendance, marks, and class.
\nParameters:
studentId as params.
Returns:
The deleted student object.
Title: Get a Student
\nDescription:
This request retrieves a student's details from the inventory. It accepts the student's name as params and returns the student's details including the student's name, age, grade, gender, attendance, marks, and class.
Parameters:
studentName as params.
Returns:
A student object.
The Student Management API allows developers to perform various
student-related operations, including reading, creating, updating, and deleting student data.
Title: Get All Teachers
\nDescription:
This request retrieves a list of all teachers in the inventory. It returns
an array of teacher objects containing the teacher's name, subject, and contact.
Parameters:
None.
Returns:
An array of teacher objects.
Title: Add a Teacher
\nDescription:
This request saves new teacher data in the inventory. It accepts JSON data with teacher details and returns the created teacher object with its unique ID, name, subject, and contact.
Parameters:
JSON object containing name, subject, and contact.
Returns:
The newly added teacher object (has a unique ID, name, subject, and contact)
Title: Update a Teacher
\nDescription:
This request updates existing teacher data in the inventory. It accepts teacherId as params and JSON data with the teacher's new details and returns the updated teacher object with its unique ID, name, subject, and contact.
Parameters:
teacherId as params and a JSON object containing new details of the teacher.
Returns:
The updated teacher object (has a unique ID, name, subject, and contact)
Title: Delete a Teacher
\nDescription:
\nThis request deletes a teacher from the inventory. It accepts a teacher's ID as query params and returns the deleted teacher object containing fields like name, subject, and contact.
\nParameters:
teacherId as params.
Returns:
The deleted teacher object.
Title: Get a Teacher
\nDescription:
This request retrieves a teacher's details from the inventory. It accepts the teacher's name as params and returns the teacher's details including the teacher's name, subject, and contact.
Parameters:
teacherName as params.
Returns:
A teacher object.
The Teacher Management API allows developers to perform various
teacher-related operations, including reading, creating, updating, and deleting teacher data.