{"info":{"_postman_id":"1666ab3f-7759-401b-bc83-84bc975844fc","name":"Educational Platform API","description":"

This API will allow users to manage educational courses & quizzes against those courses.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"34287184","collectionId":"1666ab3f-7759-401b-bc83-84bc975844fc","publishedId":"2sAYQiC8dm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-29T14:10:42.000Z"},"item":[{"name":"Course EndPoints","item":[{"name":"Post course","id":"0c7f1160-dff7-4736-a169-b29c605ca98d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"category\": \"Chemistry\",\r\n \"chapters\": [\r\n {\r\n \"id\": \"1\",\r\n \"title\": \"Atomic Structure\",\r\n \"content\": \"Understanding atoms and molecules\",\r\n \"description\": \"Learn about atomic structure\",\r\n \"videoLink\": \"https://www.youtube.com/watch?v=chem101\",\r\n \"duration\": 2\r\n }\r\n ],\r\n \"description\": \"Chemistry for Class 9\",\r\n \"duration\": 20,\r\n \"instructorName\": \"Neha Verma\",\r\n \"language\": \"English\",\r\n \"level\": \"beginner\",\r\n \"price\": 600,\r\n \"status\": \"published\",\r\n \"visibility\": \"public\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4000/api/courses","description":"

Creates a new course with specified details.

Response :

201 Created : Course successfully created.
\n
400 Bad Request : Invalid or missing data in the request body.
\n

\n","urlObject":{"protocol":"http","port":"4000","path":["api","courses"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c7f1160-dff7-4736-a169-b29c605ca98d"},{"name":"Get all courses","id":"6b47cc81-73b1-4e13-8d6e-e72501c93725","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:4000/api/courses","description":"

Retrieves a list of all available courses.

Response :

200 OK : Returns an array of course objects.

\n","urlObject":{"protocol":"http","port":"4000","path":["api","courses"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b47cc81-73b1-4e13-8d6e-e72501c93725"},{"name":"Get course by Id","id":"e67ab310-58bf-4bdc-8dc2-aad5648b4bf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:4000/api/courses/{id}","description":"

Retrieves details of a specific course by its ID.

Response :

200 OK : Returns the course object.
\n
404 Not Found : Course not found.
\n

\n","urlObject":{"protocol":"http","port":"4000","path":["api","courses","{id}"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"e67ab310-58bf-4bdc-8dc2-aad5648b4bf8"},{"name":"Update a course","id":"b12e7ae4-9125-48e0-b069-2c79585459d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"category\": \"Programming\",\r\n \"chapters\": [\r\n {\r\n \"id\": \"1\",\r\n \"title\": \"Introduction to Python\",\r\n \"content\": \"Basics of Python programming\",\r\n \"description\": \"Learn Python from scratch\",\r\n \"videoLink\": \"https://www.youtube.com/watch?v=python101\",\r\n \"duration\": 4\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"title\": \"Operators in Python\",\r\n \"content\": \"Basics of Python programming\",\r\n \"description\": \"Learn Python from scratch\",\r\n \"videoLink\": \"https://www.youtube.com/watch?v=python102\",\r\n \"duration\": 6\r\n }\r\n ],\r\n \"description\": \"Python for Beginners\",\r\n \"duration\": 40,\r\n \"instructorName\": \"Amit Patel\",\r\n \"language\": \"English\",\r\n \"level\": \"beginner\",\r\n \"price\": 1000,\r\n \"status\": \"published\",\r\n \"visibility\": \"public\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4000/api/courses/{id}","description":"

Updates the details of an existing course.

Request Body (JSON) : (Same format as POST request)

Response :

200 OK : Course successfully updated.
\n
400 Bad Request : Invalid data provided.
\n
404 Not Found : Course not found.
\n

Deletes a specific course by its ID.

Response :

200 OK : Course successfully deleted.
\n
404 Not Found : Course not found.
\n

This folder contains the API responsible for managing course-related endpoints.

POST /api/courses – Create a course
GET /api/courses – Retrieve all courses
GET /api/courses/:id – Retrieve a specific course
PUT /api/courses/:id – Update a course
DELETE /api/courses/:id – Delete a course

\n","_postman_id":"a9903cab-a170-4a7f-8325-6d80820e2c21"},{"name":"Quiz EndPoints","item":[{"name":"Post a quiz","id":"dd9e7438-e01e-499f-826e-f1e7a39c1eb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"q22\",\r\n \"questions\": [\r\n {\r\n \"id\": \"q1\",\r\n \"question\": \"Which of these is a backend programming language?\",\r\n \"options\": [\r\n \"HTML\",\r\n \"CSS\",\r\n \"JavaScript\",\r\n \"Python\"\r\n ],\r\n \"correctAnswer\": \"Python\"\r\n },\r\n {\r\n \"id\": \"q2\",\r\n \"question\": \"What is Node.js used for?\",\r\n \"options\": [\r\n \"Styling webpages\",\r\n \"Server-side development\",\r\n \"Managing databases\",\r\n \"Designing UI/UX\"\r\n ],\r\n \"correctAnswer\": \"Server-side development\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4000/api/courses/{courseId}/quizzes","description":"

Creates a new quiz for a specific course.

Response :

201 Created : Quiz successfully created.
\n
400 Bad Request : Invalid or missing data in the request body.
\n

\n","urlObject":{"protocol":"http","port":"4000","path":["api","courses","{courseId}","quizzes"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd9e7438-e01e-499f-826e-f1e7a39c1eb4"},{"name":"Get all quizzes for a course","id":"7c8a09c1-f644-49a9-97e6-760e85a9649a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:4000/api/courses/{courseId}/quizzes","description":"

Retrieves all quizzes associated with a specific course.

Response :

200 OK : Returns an array of quiz objects.
\n
404 Not Found : Quiz not found.
\n

\n","urlObject":{"protocol":"http","port":"4000","path":["api","courses","{courseId}","quizzes"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c8a09c1-f644-49a9-97e6-760e85a9649a"},{"name":"Get a quiz","id":"a18dee3a-1b4f-4d34-b371-9a14b1bece6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:4000/api/quizzes/{id}","description":"

Retrieves details of a specific quiz by its ID.

Response :

200 OK : Returns the quiz object.
\n
404 Not Found : Quiz not found.
\n

\n","urlObject":{"protocol":"http","port":"4000","path":["api","quizzes","{id}"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"a18dee3a-1b4f-4d34-b371-9a14b1bece6f"},{"name":"Update a quiz","id":"b9a1c9cc-a996-4889-963e-670a9a038f5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"q21\",\r\n \"courseId\": \"6799e8ec2f3020efe1ddc922\",\r\n \"questions\": [\r\n {\r\n \"id\": \"q1\",\r\n \"question\": \"What is the correct way to declare a JavaScript variable??\",\r\n \"options\": [\r\n \"variable x = 5;\",\r\n \"var x = 5;\",\r\n \"x = 5;\",\r\n \"v x = 5;\"\r\n ],\r\n \"correctAnswer\": \"var x=5;\"\r\n }\r\n ]\r\n }","options":{"raw":{"language":"json"}}},"url":"http://localhost:4000/api/quizzes/{id}","description":"

Updates the details of an existing quiz.

Response :

200 OK : Quiz successfully updated.
\n
400 Bad Request : Invalid data provided.
\n
404 Not Found : Quiz not found.
\n

Deletes a specific quiz by its ID.

Response :

200 OK : Quiz successfully deleted.
\n
404 Not Found : Quiz not found.
\n

This folder contains the API responsible for managing quiz-related endpoints.

POST /api/courses/:courseId/quizzes – Create a quiz for a course
GET /api/courses/:courseId/quizzes – Retrieve all quizzes for a course
GET /api/quizzes/:id – Retrieve a specific quiz
PUT /api/quizzes/:id – Update a quiz
DELETE /api/quizzes/:id – Delete a quiz

\n","_postman_id":"3fbadb9b-1998-4ae7-a64c-7cab5136e24d"}]}