Registers a new admin user along with their institution details on the Anginat Learning platform.
\nDescription:
\nThis endpoint allows the creation of a new admin user and simultaneously registers the associated institution. The admin can later access and manage the institution through their dashboard.
\nAuthentication:
\nNo authentication required for this endpoint (open registration).
\n(Can be restricted later via internal token or approval workflow if needed.)
\nField Descriptions:
\nSuccess Response:
\nStatus: 201 Created
Content-Type: application/json
{\n \"message\": \"Admin and institution registered successfully\",\n \"adminId\": \"abc123\",\n \"institutionId\": \"inst456\"\n}\n\nError Responses:
\nExample Request (cURL):
\ncurl -X POST https://api.anginat.com/api/auth/register-admin \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"tarankalsi0123@gmail.com\",\n \"phoneNumber\": \"9818129221\",\n \"username\": \"singhjeet\",\n \"password\": \"securepass\",\n \"role\": \"admin\",\n \"status\": \"active\",\n \"institutionData\": {\n \"name\": \"cdba school\",\n \"address\": \"IITM\",\n \"email\": \"tarankalsi0123@gmail.com\",\n \"institutionType\": \"college\",\n \"domainName\": \"kalsi.com\",\n \"status\": \"active\"\n }\n }'\n\nAuthenticates a user (admin, instructor, or student) and returns a secure access token for further requests.
\nDescription:
\nThis endpoint allows any registered user to log in using either their email or username along with a password. Upon successful authentication, the server returns a JWT or token along with user role and relevant session details.
\nAuthentication:
\nNot required for this endpoint.
\nRequest Body:
\n{\n{\n \"message\": \"Login successful\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"user\": {\n \"id\": \"user123\",\n \"username\": \"singhjeet\",\n \"email\": \"taranjeet3412@gmail.com\",\n \"role\": \"admin\"\n }\n}\n\nField Descriptions:
\nSuccess Response:
\nStatus: 200 OK
Content-Type: application/json
{\n \"message\": \"Login successful\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"user\": {\n \"id\": \"user123\",\n \"username\": \"singhjeet\",\n \"email\": \"taranjeet3412@gmail.com\",\n \"role\": \"admin\"\n }\n}\n\nError Responses:
\n","urlObject":{"path":["login"],"host":["{{AuthbaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"74845d52-f11c-404c-aed6-d138cda5e2d0"},{"name":"ForgotPassword","id":"f10227a9-aec9-4425-82b8-fa433ba2b193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"tarankhalsa3412@gmail.com\",\r\n \"otpType\": \"email\" \r\n}","options":{"raw":{"language":"json"}}},"url":"{{AuthbaseURL}}/forgot-password","description":"This endpoint allows users to initiate the password recovery process by sending a request to receive a One-Time Password (OTP) via email. It is essential for users who have forgotten their passwords and need to reset them securely.
\nMethod: POST
\nURL: {{AuthbaseURL}}/forgot-password
The request body must be in JSON format and should include the following parameters:
\nemail (string): The email address associated with the user's account. This is where the OTP will be sent.
\notpType (string): Specifies the type of OTP to be sent. In this case, it should be set to \"email\" to indicate that the OTP should be sent to the provided email address.
\nExample Request Body:
\n{\n \"email\": \"user@example.com\",\n \"otpType\": \"email\"\n}\n\nUpon a successful request, the server will respond with a confirmation message indicating that the OTP has been sent to the user's email. The response will typically include:
\nstatus (string): Indicates the success or failure of the request.
\nmessage (string): A descriptive message providing further details about the request outcome.
\nExample Response:
\n{\n \"status\": \"success\",\n \"message\": \"OTP has been sent to your email.\"\n}\n\nEnsure that the email provided is valid and registered in the system to receive the OTP.
\nThe OTP sent via email will be required for the subsequent steps to reset the password.
\nThis endpoint allows users to update their password associated with their email address.
\nMethod: POST
\nURL: {{AuthbaseURL}}/update-password
Content-Type: application/json
\nemail (string): The email address of the user whose password is being updated. This is required to identify the account.
\nnewPassword (string): The new password that the user wishes to set. This should meet the security requirements set by the application.
\nUpon a successful request, the server will respond with a confirmation message indicating that the password has been updated. The response will typically include:
\nA success status code (e.g., 200 OK)
\nA message confirming the password update
\nEnsure that the new password complies with any specified security policies (e.g., minimum length, complexity).
\nIf the email provided does not correspond to an existing account, an appropriate error message will be returned.
\nThis endpoint is intended for authenticated users, and appropriate authentication headers should be included in the request.
\nMake sure to handle any errors gracefully in your application to provide a better user experience.
\n","urlObject":{"path":["update-password"],"host":["{{AuthbaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"475cd8cb-b687-4a6b-8b58-413338be7f44"},{"name":"GetInstitutionDetails","id":"8c560e69-77ec-4fa3-ae14-f65886134020","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4Mzg1ZWJkNjJlN2ZkMTE1N2EzN2ZhYyIsInJvbGUiOiJpbnN0cnVjdG9yIiwiaW5zdGl0dXRpb24iOiI2ODMwNmM5ODM4N2EwMjdmOGE3MDkyOWIiLCJpbnN0aXR1dGlvblR5cGUiOiJjb2xsZWdlIiwiaWF0IjoxNzUxNzg5MTY1LCJleHAiOjE3NTE3OTI3NjV9.LqzEUJRcITeWMPdtovah2KzW89EQjJY6niBg4UUq3O4","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{AuthbaseURL}}/get-institution","description":"This endpoint retrieves information about institutions from the system. It is designed to provide users with a list of available institutions, which can be useful for various purposes such as selection or verification.
\nMethod: GET
\nEndpoint: {{AuthbaseURL}}/get-institution
This endpoint does not require any input parameters in the request body. The request is made without any specific payload.
\nThe response will contain a list of institutions, typically structured as follows:
\ninstitutions: An array of institution objects, where each object may contain:
\nid: Unique identifier for the institution.
\nname: The name of the institution.
\ntype: The type of institution (e.g., university, college).
\nlocation: The geographical location of the institution.
\n{\n \"institutions\": [\n {\n \"id\": \"123\",\n \"name\": \"Example University\",\n \"type\": \"University\",\n \"location\": \"City, Country\"\n },\n {\n \"id\": \"456\",\n \"name\": \"Sample College\",\n \"type\": \"College\",\n \"location\": \"City, Country\"\n }\n ]\n}\n\nEnsure that you have the necessary authentication to access this endpoint.
\nThe response may vary depending on the available institutions in the system.
\nThis endpoint is useful for applications that require institution selection or display of available options to users.
\nThis endpoint retrieves user information based on the provided authentication credentials.
\nGET
{{AuthbaseURL}}/get-user
This endpoint does not require any additional query parameters or body content. It relies on the authentication context established in the request headers.
\nUpon a successful request, the server responds with a JSON object containing user details. The structure of the response typically includes:
\nuserId: Unique identifier for the user.
username: The user's username.
email: The user's email address.
profile: Additional profile information.
In case of an error, the response will include an error message detailing the issue encountered during the request.
\nEnsure that the request is made with valid authentication to receive the appropriate user data.
\n","urlObject":{"path":["get-user"],"host":["{{AuthbaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9bb90a88-ebb9-4737-b6f9-2859623ee73e"},{"name":"RefreshToken","id":"967e1877-b4d0-431f-8564-a28fb1f6068e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4MzA2Yzk4Mzg3YTAyN2Y4YTcwOTI5ZCIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjgzMDZjOTgzODdhMDI3ZjhhNzA5MjliIiwiaW5zdGl0dXRpb25UeXBlIjoiY29sbGVnZSIsImlhdCI6MTc1MDc2MTI0MiwiZXhwIjoxNzUxMzY2MDQyfQ.PIKSoqkLnGJV06qD0Aan2gzoy6RgV-H0XmLEV_4GNe8","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{AuthbaseURL}}/refresh-token","description":"This endpoint allows users to refresh their authentication tokens. It is essential for maintaining user sessions without requiring them to log in again. By sending a valid refresh token, the user can obtain a new access token, which can be used for subsequent API requests.
\nMethod: POST
URL: {{AuthbaseURL}}/auth/refresh-token
The request must include the following parameters in the body:
\nUpon a successful request, the API will return a response with the following structure:
\naccess_token (string): The new access token that can be used for authenticating subsequent requests.
\nexpires_in (integer): The duration (in seconds) until the access token expires.
\ntoken_type (string): The type of token returned, typically \"Bearer\".
\n{\n \"access_token\": \"new_access_token_value\",\n \"expires_in\": 3600,\n}\n\nThis endpoint is crucial for maintaining secure user sessions and ensuring a seamless user experience by allowing token renewal without re-authentication.
\n","urlObject":{"path":["refresh-token"],"host":["{{AuthbaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"967e1877-b4d0-431f-8564-a28fb1f6068e"},{"name":"Create User","id":"e2dd7c91-1791-4d1b-8add-8b42edc10b3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"name\":\"Proffessor Simmi Chawla\",\r\n \"email\": \"instructor@demo.com\",\r\n \"phoneNumber\": \"1234567890\",\r\n \"username\": \"instructor01\",\r\n \"password\": \"securepass\",\r\n \"role\":\"instructor\",\r\n \"status\" : \"active\",\r\n \"institutionId\":\"68306c98387a027f8a70929b\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{AuthbaseURL}}/create-user","description":"This endpoint allows you to create a new user in the system. It accepts user details in the request body and returns a confirmation of the user creation.
\nPOST
{{AuthbaseURL}}/create-user
The request body must be in JSON format and include the following parameters:
\nname (string): The full name of the user.
email (string): The email address of the user.
phoneNumber (string): The contact number of the user.
username (string): The unique username for the user.
password (string): The password for the user account.
role (string): The role assigned to the user (e.g., instructor).
status (string): The current status of the user (e.g., active).
institutionId (string): The identifier for the institution the user is associated with.
Upon a successful request, the API will return a response confirming the creation of the user. The response typically includes a status message and may also contain the newly created user's details.
\nMake sure to provide valid data for all required fields to ensure successful user creation.
\n","urlObject":{"path":["create-user"],"host":["{{AuthbaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2dd7c91-1791-4d1b-8add-8b42edc10b3c"},{"name":"verifyToken","id":"75a418c7-49cb-4bb0-a451-574d59e5d8f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"url":"{{AuthbaseURL}}/verify-token","description":"This endpoint is used to verify the validity of a provided authentication token. It checks whether the token is still active and associated with a valid user session.
\nBearer {token}.On a successful verification, the response will include:
\nstatus: Indicates the result of the verification process (e.g., success or failure).
\nuserId: The identifier of the user associated with the token, if valid.
\nexpiresAt: The expiration time of the token, indicating how long it remains valid.
\nEnsure that the token is included in the Authorization header to avoid authentication errors.
\nIf the token is invalid or expired, the response will indicate the failure and may include an error message.
\nThis endpoint allows you to find a user in the system based on their phone number. It is primarily used for user identification and retrieval of user-related information.
\nMethod: POST
\nURL: {{AuthbaseURL}}/find-user
Content-Type: application/json
\nThe request body must be in JSON format and should include the following parameter:
\nExample Request Body:
\n{\n \"phoneNumber\": \"8287193995\"\n}\n\nThe expected response will include user details if the phone number matches an existing user in the system. The structure of the response will typically contain user information such as user ID, name, and other relevant details.
\nEnsure that the phone number provided is correctly formatted to avoid errors.
\nThis endpoint is useful for applications that require user verification or identification based on phone numbers.
\nEndpoint:POST {{CoursebaseURL}}/courses/create-course
Creates a new course with its pricing, instructors, batches, languages, and thumbnail image.
\n✅ Required (e.g., Bearer Token)
\nmultipart/form-data
payload (as stringified JSON):jsonCopyEdit{\n \"institutionCode\": \"AL_24_0001\",\n \"institution\": \"673f4bfa1c208ed487d658b0\",\n \"courseName\": \"Advanced Html\",\n \"description\": \"Learn advanced concepts of JavaScript programming.\",\n \"pricingType\": \"batch\",\n \"price\": [\n {\n \"currency\": \"NGN\",\n \"offerPrice\": 5000,\n \"standardPrice\": 10000\n }\n ],\n \"instructor\": [\"64b8c9ede7891c001edc78ac\"],\n \"languages\": [\"English\", \"Spanish\"],\n \"batches\": [\n {\n \"name\": \"Evening Batch\",\n \"startDate\": \"2024-12-15\",\n \"endDate\": \"2024-12-19\",\n \"timeZone\": \"6:00 PM - 8:00 PM\",\n \"seats\": 25,\n \"status\": \"active\"\n }\n ],\n \"status\": \"active\"\n}\n\nthumbnail:Use a file field named thumbnail and attach a .png, .jpg, or .jpeg file representing the course image.
Code: 201 Created
Body Example:
\njsonCopyEdit{\n \"success\": true,\n \"message\": \"Course created successfully.\",\n \"data\": {\n \"_id\": \"67cf5fc7b28fdd8eccca67d9\",\n \"courseName\": \"Advanced Html\",\n ...\n }\n}\n\nThis endpoint allows you to update the thumbnail for a specific course identified by its unique ID. The course ID in this example is 6749c0bdc6a2b3794938118c.
Method: PUT
\nURL: {{CoursebaseURL}}/courses/{courseId}
Request Body: The request body should be sent as form-data and must include the following parameters:
\nthumbnail: A file parameter that represents the new thumbnail image for the course.
payload: A text parameter that may contain additional information or metadata related to the thumbnail update.
Upon a successful update, the server will respond with a confirmation message, typically including the status of the operation and any relevant details about the updated course. The response will be in JSON format, containing keys that indicate the success of the request and the updated course information.
\n","urlObject":{"path":["courses","6749d7def99edee8975297b1"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"25fe6c1f-b0e3-41db-833a-4e7797a2593e"},{"name":"AddPricing","id":"3a1c2d0b-c15d-4642-937e-44b3a6bf2d49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3MjYyNTdhYzk2NTZlMmY2YWRkM2M1NyIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjcyNjI1N2FjOTY1NmUyZjZhZGQzYzU1IiwiaWF0IjoxNzM0MTMzODczLCJleHAiOjE3MzQxMzc0NzN9.x-fUDLEIQJTRd4MdKPUltbRoaM5voHb8iroeXwJZ9VY","type":"text"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/C:/Users/micha/Downloads/mycsv.csv"},{"key":"payload","value":"{\n \"courseName\": \"Advanced Html\",\n \"description\": \"Learn advanced concepts of JavaScript programming.\",\n \"pricingType\": \"one-time\",\n \"languages\": [\"English\", \"Spanish\"],\n \"status\": \"active\"\n}","type":"text","disabled":true}]},"url":"{{CoursebaseURL}}/courses/67461cea3d3904acad48fd6e/pricing/upload","description":"This endpoint allows you to upload a pricing file for a specific course identified by its unique ID. The request is made via an HTTP POST method to the specified course's pricing upload URL.
\nUpon a successful upload, the API will return a response indicating the status of the upload. The response typically includes information such as:
\nConfirmation of the upload
\nAny relevant metadata about the uploaded file
\nError messages if the upload fails
\nMake sure that the file you are uploading adheres to the required format and size limitations.
\nEnsure that the course ID in the URL is correct, as this determines which course the pricing file will be associated with.
\nCheck for appropriate permissions to upload files to the specified course.
\nThis endpoint is crucial for maintaining up-to-date pricing information for courses in the system.
\n","urlObject":{"path":["courses","67461cea3d3904acad48fd6e","pricing","upload"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a1c2d0b-c15d-4642-937e-44b3a6bf2d49"},{"name":"GetCourses","id":"40c35cb0-2d7f-4659-aa71-f947e59f2ef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4Mzg1ZWJkNjJlN2ZkMTE1N2EzN2ZhYyIsInJvbGUiOiJpbnN0cnVjdG9yIiwiaW5zdGl0dXRpb24iOiI2ODMwNmM5ODM4N2EwMjdmOGE3MDkyOWIiLCJpbnN0aXR1dGlvblR5cGUiOiJjb2xsZWdlIiwiaWF0IjoxNzUxNzg5MTY1LCJleHAiOjE3NTE3OTI3NjV9.LqzEUJRcITeWMPdtovah2KzW89EQjJY6niBg4UUq3O4","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{CoursebaseURL}}/courses","description":"This endpoint retrieves a list of courses available in the system. It allows users to access course information, which may include details such as course titles, descriptions, and other relevant metadata.
\nMethod: GET
\nURL: {{CoursebaseURL}}/courses
Request Body: None
\nThe response will be in JSON format and typically includes an array of course objects. Each course object may contain the following fields:
\nid: Unique identifier for the course
title: Title of the course
description: Brief description of the course
duration: Duration of the course
instructor: Name of the instructor for the course
The response will provide users with the necessary details to understand the courses offered.
\n","urlObject":{"path":["courses"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"40c35cb0-2d7f-4659-aa71-f947e59f2ef6"},{"name":"GetCourse","id":"2cf409c8-b017-4856-a4a9-c5e68ec21173","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3MjYyNTdhYzk2NTZlMmY2YWRkM2M1NyIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjcyNjI1N2FjOTY1NmUyZjZhZGQzYzU1IiwiaWF0IjoxNzM0NDYxNjM1LCJleHAiOjE3MzQ0NjUyMzV9.VF2LsZMWQB-zczCltdrhpANC2rN-o-DH5wfchPyJXhY","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{CoursebaseURL}}/courses/6749d7def99edee8975297b1","description":"This endpoint retrieves detailed information about a specific course identified by its unique course ID.
\nMethod: GET
\nURL: {{CoursebaseURL}}/courses/{courseId}
Path Parameter:
\ncourseId (string): The unique identifier of the course you want to retrieve. In this example, the course ID is 6749d7def99edee8975297b1.Upon a successful request, the API will return a response containing the details of the course. The expected response will typically include:
\nCourse title
\nDescription
\nDuration
\nInstructor information
\nEnrollment details
\nEnsure that the course ID provided in the request is valid and exists in the system to avoid errors.
\nThe response will be in JSON format, and it will contain all relevant details associated with the specified course ID.
\nThis endpoint retrieves the domain information associated with a specific course identified by its unique courseId.
Method: POST
\nURL: {{CoursebaseURL}}/courses/get-course-domain
The request body must be in JSON format and should contain the following parameter:
\nExample Request Body:
\n{\n \"courseId\": \"67461cea3d3904acad48fd6e\"\n}\n\nEnsure to include the following headers in your request:
\nContent-Type: application/json - This indicates that the request body is in JSON format.The response will contain the domain information for the specified course. The structure of the response may include:
\ndomain (string): The domain associated with the course.
\nstatus (string): Indicates the success or failure of the request.
\nmessage (string): Provides additional information about the request status.
\nExample Response:
\n{\n \"domain\": \"example.course.com\",\n \"status\": \"success\",\n \"message\": \"Domain retrieved successfully.\"\n}\n\nThis endpoint is essential for obtaining the domain details of a course, allowing users to access course-specific resources effectively.
\n","urlObject":{"path":["courses","get-course-domain"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b976f5f2-9d92-441d-bf9f-809633e8d94c"},{"name":"DeleteCourse","id":"d312e84c-4dbd-4b5d-a0b8-aa1b3ee0f0fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3MjYyNTdhYzk2NTZlMmY2YWRkM2M1NyIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjcyNjI1N2FjOTY1NmUyZjZhZGQzYzU1IiwiaWF0IjoxNzMyMDY4NDcyLCJleHAiOjE3MzIwNzIwNzJ9.dsSmQp0XZVuQ72xQVSaUX8UCj96g7lKxGHgfjpq8ALo","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{CoursebaseURL}}/courses/67481ebff99edee897525de7","description":"This endpoint is used to delete a specific course from the system. The course is identified by its unique courseId, which is included in the URL path.
67481ebff99edee897525de7.Upon successful deletion of the course, the API will return a response indicating the outcome of the operation. The response structure typically includes:
\nstatus: Indicates whether the deletion was successful (e.g., success or error).
\nmessage: Provides additional information about the result of the deletion request.
\nRequest: DELETE {{CoursebaseURL}}/courses/67481ebff99edee897525de7
{ \"status\": \"success\", \"message\": \"Course deleted successfully.\"}
\nEnsure that you have the necessary permissions to delete a course when making this request.
\n","urlObject":{"path":["courses","67481ebff99edee897525de7"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d312e84c-4dbd-4b5d-a0b8-aa1b3ee0f0fb"},{"name":"Get Courses of Institute","id":"01a5352a-fd62-4eb2-a295-a3e1db4a77ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{CoursebaseURL}}/courses/get-institute-courses/6726257ac9656e2f6add3c55","description":"This endpoint retrieves a list of courses associated with a specific institute identified by its unique ID.
\nMethod: GET
\nURL: {{CoursebaseURL}}/courses/get-institute-courses/{instituteId}
instituteId (string): The unique identifier for the institute whose courses are being requested. In this example, the value is 6726257ac9656e2f6add3c55.The response will contain a structured JSON object that includes details about the courses offered by the specified institute. The structure typically includes:
\ncourses (array): A list of course objects, each containing:
\ncourseId (string): The unique identifier for the course.
courseName (string): The name of the course.
courseDescription (string): A brief description of the course content.
duration (string): The duration of the course.
instructor (string): The name of the instructor for the course.
{\n \"courses\": [\n {\n \"courseId\": \"course_1\",\n \"courseName\": \"Introduction to Programming\",\n \"courseDescription\": \"Learn the basics of programming.\",\n \"duration\": \"3 months\",\n \"instructor\": \"John Doe\"\n },\n {\n \"courseId\": \"course_2\",\n \"courseName\": \"Advanced Data Structures\",\n \"courseDescription\": \"Deep dive into data structures.\",\n \"duration\": \"4 months\",\n \"instructor\": \"Jane Smith\"\n }\n ]\n}\n\nThis endpoint is useful for retrieving course information for students, administrators, or any stakeholders interested in the offerings of a particular institute.
\n","urlObject":{"path":["courses","get-institute-courses","6726257ac9656e2f6add3c55"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"01a5352a-fd62-4eb2-a295-a3e1db4a77ac"}],"id":"2054f618-b420-4dff-b4e1-4fbcfdfc2f8e","_postman_id":"2054f618-b420-4dff-b4e1-4fbcfdfc2f8e","description":""},{"name":"LeadService","item":[{"name":"GetAllLeads","id":"f59634ec-44eb-4ab2-a5cd-b7ec87157489","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3MjYyNTdhYzk2NTZlMmY2YWRkM2M1NyIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjcyNjI1N2FjOTY1NmUyZjZhZGQzYzU1IiwiaWF0IjoxNzM1Mzc5NTE1LCJleHAiOjE3MzUzODMxMTV9.co2w0nMAls6TXYcW9YjEArVnkdauJ9nD1LX-AKVBQJU","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{LeadURL}}/leads","description":"This endpoint retrieves a list of leads from the system.
\nThis is a GET request and does not require any input parameters.
\nThe response will return a JSON object containing the following fields:
\nleads: An array of lead objects, each containing details about a specific lead.
Each lead object may include properties such as:
\nid: Unique identifier for the lead.
name: Name of the lead.
email: Email address of the lead.
status: Current status of the lead.
Other relevant fields related to the lead.
\n{\n \"leads\": [\n {\n \"id\": \"123\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"status\": \"active\"\n },\n {\n \"id\": \"124\",\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@example.com\",\n \"status\": \"inactive\"\n }\n ]\n}\n\nThis endpoint is useful for fetching all leads available in the system for further processing or analysis.
\n","urlObject":{"path":["leads"],"host":["{{LeadURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f59634ec-44eb-4ab2-a5cd-b7ec87157489"},{"name":"UpdateLeads","id":"38544899-9f46-4194-b9fd-e0797634efc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3M2Y0YmZhMWMyMDhlZDQ4N2Q2NThiMiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjczZjRiZmExYzIwOGVkNDg3ZDY1OGIwIiwiaWF0IjoxNzMyODY3ODU4LCJleHAiOjE3MzI4NzE0NTh9.n-UNMctGUWEdambZOAd--crCkB8orvMsOYkr4_Nc5wA","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"leadId\": \"673edaf001b1cce4ef15b3ab\",\r\n \"updateData\": {\r\n \"status\": \"Restore\",\r\n \"course\": \"Agile and Scrums\" ,\r\n \"applicantName\": \"Satyam test\",\r\n \"phoneNumber\": \"9650582767\", \r\n \"email\": \"satyamvatsa@gmail.com\"\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{LeadURL}}/lead/lead/status","description":"This endpoint allows you to update the status of a lead in the system. You can change the lead's status and provide additional information such as the course, applicant's name, phone number, and email.
\nleadId (string): The unique identifier for the lead that you want to update.
\nupdateData (object): An object containing the details to be updated for the lead.
\nstatus (string): The new status of the lead (e.g., \"Restore\").
\ncourse (string): The course associated with the lead (e.g., \"Agile and Scrums\").
\napplicantName (string): The name of the applicant.
\nphoneNumber (string): The phone number of the applicant.
\nemail (string): The email address of the applicant.
\nUpon a successful request, the server will respond with a confirmation of the updated lead status. The response will typically include details about the updated lead, confirming that the changes have been applied.
\nEnsure that the leadId provided corresponds to an existing lead in the system.
The updateData object must include valid values for all fields to avoid validation errors.
This endpoint is designed for partial updates, so only the fields included in the updateData will be modified.
This endpoint allows you to create a new lead in the system. By sending a POST request to {{LeadURL}}/create, you can submit the details of an applicant interested in a course.
The request body must be in JSON format and include the following parameters:
\ninstitutionDomain (string): The domain of the institution offering the course.
\ncourse (string): The name of the course the applicant is interested in.
\napplicantName (string): The full name of the applicant.
\nphoneNumber (string): The contact phone number of the applicant.
\nemail (string): The email address of the applicant.
\nstatus (string): The current status of the lead (e.g., \"Pending\").
\nUpon a successful request, the response will typically include a confirmation of the lead creation along with relevant details of the newly created lead. The structure of the response will provide information that may include the lead ID, status message, and any additional metadata related to the created lead.
\nMake sure to validate the input parameters before sending the request to ensure successful lead creation.
\n","urlObject":{"path":["create"],"host":["{{LeadURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"45231f90-926b-48ba-a220-86a91026d9b0"},{"name":"Contact Us Form","id":"a99a5fdf-c34e-43ea-a6c4-a478a2e751d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"tarankhalsa3412@gmail.com\",\r\n \"name\":\"Taranjit Singh\",\r\n \"message\":\"Hi how are you?\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{LeadURL}}/contact-us","description":"This endpoint allows users to submit inquiries or messages through a contact form. It is designed to facilitate communication between users and the service team.
\nPOST
The request body must be sent in JSON format and should include the following parameters:
\nemail (string): The email address of the user submitting the inquiry.
\nname (string): The full name of the user.
\nmessage (string): The message or inquiry that the user wishes to send.
\nExample Request Body:
\n{\n \"email\": \"user@example.com\",\n \"name\": \"John Doe\",\n \"message\": \"Hello, I would like to know more about your services.\"\n}\n\nUpon successful submission, the server will respond with a confirmation message indicating that the inquiry has been received. The response will typically include:
\nstatus (string): A message indicating the success or failure of the request.
\ndata (object): An object containing any additional information related to the inquiry, if applicable.
\nExample Response:
\n{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"Your message has been sent successfully.\"\n }\n}\n\nMake sure to provide valid email and message content to ensure proper handling of your request.
\n","urlObject":{"path":["contact-us"],"host":["{{LeadURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a99a5fdf-c34e-43ea-a6c4-a478a2e751d0"},{"name":"Institute Contact Us","id":"c3d6d3cc-a167-4ea7-93a6-4c89f1568d1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Taranjit\",\r\n \"lastName\":\"Singh\",\r\n \"phoneNumber\":\"8287193995\",\r\n \"message\":\"Hi how are you?\",\r\n \"email\":\"tarankhalsa3412@gmail.com\",\r\n \"receiverEmail\":\"taranjeet3412@gmail.com\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{LeadURL}}/institute-contact-form","description":"This endpoint allows users to submit an institute contact form. The request requires the user's personal information and a message to be sent to the designated receiver.
\nThe request body must be in JSON format and include the following parameters:
\nfirstName (string): The first name of the user submitting the form.
lastName (string): The last name of the user submitting the form.
phoneNumber (string): The contact phone number of the user.
message (string): A message or inquiry from the user.
email (string): The email address of the user submitting the form.
receiverEmail (string): The email address of the receiver who will receive the message.
Upon successful submission of the contact form, the API will respond with a confirmation message indicating that the form has been submitted successfully. The exact structure of the response may vary based on the implementation.
\nEnsure that all required fields are filled out correctly to avoid validation errors.
\nThe phone number should be in a valid format to ensure proper communication.
\nThis endpoint is designed for use by individuals seeking to reach out to the institute for inquiries or support.
\nThis endpoint allows users to schedule a product demo by submitting relevant details through an HTTP POST request. The information provided will be used to arrange a demonstration of the product, tailored to the user's preferences.
\nThe request body must be in JSON format and include the following parameters:
\nname (string): The full name of the individual requesting the demo.
\nemail (string): The email address of the requester, used for confirmation and communication.
\ncompany (string): The name of the company the requester represents.
\nphoneNumber (string): A contact number for the requester, which may be used for follow-up.
\neventType (string): The type of event being scheduled, in this case, it should be \"Product Demo\".
\npreferedDate (string): The preferred date for the demo in the format YYYY-MM-DD.
\npreferedTime (string): The preferred time for the demo in the format HH:MM (24-hour format).
\nexpectedAttendees (integer): The estimated number of attendees for the demo session.
\nmessage (string): An optional message from the requester, providing additional context or questions.
\nUpon successful scheduling of the demo, the API will respond with a confirmation message, which typically includes:
\nstatus (string): Indicates whether the demo scheduling was successful or if there was an error.
\ndemoId (string): A unique identifier for the scheduled demo, which can be used for future reference.
\nscheduledDate (string): The date and time the demo has been scheduled for.
\n{\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\",\n \"company\": \"Acme Corp\",\n \"phoneNumber\": \"+1234567890\",\n \"eventType\": \"Product Demo\",\n \"preferedDate\": \"2025-07-03\",\n \"preferedTime\": \"14:00\",\n \"expectedAttendees\": 25,\n \"message\": \"Looking forward to learning more about the product.\"\n}\n\nThis endpoint is essential for facilitating product demonstrations and ensuring that potential clients have a seamless experience when scheduling their sessions.
\n","urlObject":{"path":["schedule-demo"],"host":["{{LeadURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c300cbda-9c7b-4f54-9574-65de8494d2b4"},{"name":"Event Contact Us","id":"faa6c603-5153-435f-8142-222699809af6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"taran\",\r\n \"email\":\"tarankhalsa3412@gmail.com\",\r\n \"subect\":\"Test\",\r\n \"message\":\"Hello\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{LeadURL}}/events-contact-us","description":"This endpoint allows users to submit a contact form with their details and message. It is typically used for inquiries or feedback.
\nThe request must be sent in JSON format and should include the following fields:
\nname (string): The name of the person submitting the form.
\nemail (string): The email address of the person submitting the form.
\nsubect (string): The subject of the message (note the typo in the key).
\nmessage (string): The content of the message being sent.
\n{\n \"name\": \"string\",\n \"email\": \"string\",\n \"subect\": \"string\",\n \"message\": \"string\"\n}\n\nUpon successful submission, the server will respond with a confirmation message indicating that the contact form has been received. The response will typically include a status code and a message confirming the submission.
\n{\n \"status\": \"success\",\n \"message\": \"Your message has been sent successfully.\"\n}\n\nEnsure that the request body adheres to the specified format for successful processing.
\n","urlObject":{"path":["events-contact-us"],"host":["{{LeadURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"faa6c603-5153-435f-8142-222699809af6"}],"id":"861b6b8a-8a31-424b-bb81-f37dc4066348","_postman_id":"861b6b8a-8a31-424b-bb81-f37dc4066348","description":""},{"name":"OTPService","item":[{"name":"VerifyOTP","id":"da45dd0e-c981-4f63-89ce-dd333328db66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"otp\": \"668521\",\r\n \"otpType\": \"email\",\r\n \"receiverId\":\"tarankhalsa3412@gmail.com\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{OTPURL}}/verify","description":"This endpoint is used to verify a One-Time Password (OTP) that has been sent to a user via email. It is essential for confirming the identity of the user during authentication processes.
\nMethod: POST
\nURL: {{OTPURL}}/verify
The request body must be in JSON format and include the following parameters:
\notp (string, required): The OTP code that the user has received.
\notpType (string, required): The type of OTP being verified. In this case, it should be set to \"email\".
\nreceiverId (string, required): The email address of the user to whom the OTP was sent.
\nExample Request Body:
\n{\n \"otp\": \"668521\",\n \"otpType\": \"email\",\n \"receiverId\": \"example@example.com\"\n}\n\nThe response from this endpoint will typically include a status indicating whether the OTP verification was successful or not. The structure of the response may vary based on the implementation but generally includes the following fields:
\nstatus (string): Indicates the result of the verification (e.g., \"success\" or \"failure\").
\nmessage (string): A message providing additional information about the verification result.
\nExample Response:
\n{\n \"status\": \"success\",\n \"message\": \"OTP verified successfully.\"\n}\n\nEnsure that the request body is correctly formatted and that the OTP matches the one sent to the specified email address for successful verification.
\n","urlObject":{"path":["verify"],"host":["{{OTPURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"da45dd0e-c981-4f63-89ce-dd333328db66"},{"name":"GenerateOTP","id":"b56a1e85-0e52-4b07-942d-b2439ef749bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"receiverId\": \"9650582767\", \r\n \"otpType\": \"phone\" \r\n}","options":{"raw":{"language":"json"}}},"url":"{{OTPURL}}/generate","description":"This endpoint is used to generate a One-Time Password (OTP) for a specified receiver. The OTP can be sent via different channels, such as SMS or email, depending on the otpType provided in the request.
Method: POST
\nURL: {{OTPURL}}/generate
The request body must be in JSON format and should include the following parameters:
\nreceiverId (string): The identifier for the recipient of the OTP. This can be a phone number or an email address, depending on the context.
\notpType (string): Specifies the type of OTP to be generated. In this case, it is set to \"phone\" to indicate that the OTP should be sent to the receiver's phone.
\nExample Request Body:
\n{\n \"receiverId\": \"9650582767\",\n \"otpType\": \"phone\"\n}\n\nEnsure to include the following headers in your request:
\napplication/json - This header indicates that the request body is in JSON format.The response will typically contain a status indicating the success or failure of the OTP generation process. The structure of the response may include:
\nstatus (string): Indicates whether the OTP generation was successful or not.
\nmessage (string): A descriptive message providing additional information about the result of the request.
\nExample Response:
\n{\n \"status\": \"success\",\n \"message\": \"OTP has been sent successfully.\"\n}\n\nEnsure that the receiverId is valid and formatted correctly based on the otpType specified.
Handle any error responses gracefully, as they may contain useful information for debugging.
\nThis endpoint allows you to update the details of a specific batch within a course. By sending a PUT request to the specified URL, you can modify various attributes of the batch, including its name, start and end dates, time zone, available seats, status, batch type, and pricing information.
\nThe request body must be in JSON format and include the following parameters:
\nname (string): The new name for the batch.
\nstartDate (string, ISO 8601 format): The starting date and time of the batch.
\nendDate (string, ISO 8601 format): The ending date and time of the batch.
\ntimeZone (string): The time zone during which the batch operates.
\nseats (integer): The number of available seats in the batch.
\nstatus (string): The current status of the batch (e.g., active, inactive).
\nbatchType (string): The type of the batch (e.g., weekends, weekdays).
\nprice (array of objects): An array containing pricing details. Each object should include:
\ncurrency (string): The currency of the price (e.g., USD).
\nofferPrice (integer): The promotional price for the batch.
\nstandardPrice (integer): The regular price for the batch.
\nUpon a successful update, the API will respond with a confirmation of the updated batch details. The response will typically include the updated attributes of the batch, confirming the changes made.
\n{\n \"name\": \"batchUpdated11\",\n \"startDate\": \"2024-12-28T20:00:00Z\",\n \"endDate\": \"2024-12-31T21:00:00Z\",\n \"timeZone\": \"08:00 PM - 09:00 PM\",\n \"seats\": 15,\n \"status\": \"active\",\n \"batchType\": \"weekends\",\n \"price\": [\n {\n \"currency\": \"USD\",\n \"offerPrice\": 5000,\n \"standardPrice\": 10000\n }\n ]\n}\n\nEnsure that all required fields are provided in the request for a successful update of the batch details.
\n","urlObject":{"path":["courses","674e584e0a51efbe5a2dee4d","batches","674e584e0a51efbe5a2dee4e"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3427fd0a-19ad-40e4-9470-6a2fb5f499f1"},{"name":"CreateBatch","id":"74f67d69-e98e-4330-91ca-d082bc101b78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NDRkMTIwZDJhY2QxYjBlZjQzMjM0ZCIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjc0NGQxMjBkMmFjZDFiMGVmNDMyMzRiIiwiaWF0IjoxNzM0MDAzMTc4LCJleHAiOjE3MzQwMDY3Nzh9.dSDSbEPcNSc_1V5J0CcSjXS_saycq4Hc4892mKe4-jQ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"batch21\",\r\n \"startDate\": \"2024-12-01T09:00:00Z\",\r\n \"endDate\": \"2024-12-02T09:00:00Z\",\r\n \"timeZone\": \"12:00 AM - 15:00 PM\",\r\n \"seats\": 15,\r\n \"status\": \"active\",\r\n \"batchtype\":\"weekends\",\r\n \"instructor\":\"\",\r\n \"price\": [\r\n {\r\n \"currency\": \"NGN\",\r\n \"offerPrice\": 5000,\r\n \"standardPrice\": 10000\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{CoursebaseURL}}/course/batches/67461cea3d3904acad48fd6e","description":"Endpoint:POST {{CoursebaseURL}}/course/batches/:courseId
Adds a new batch to a specific course.
\n✅ Required (e.g., Bearer Token)
\napplication/json
jsonCopyEdit{\n \"name\": \"batch21\",\n \"startDate\": \"2024-12-01T09:00:00Z\",\n \"endDate\": \"2024-12-02T09:00:00Z\",\n \"timeZone\": \"12:00 AM - 15:00 PM\",\n \"seats\": 15,\n \"status\": \"active\",\n \"batchtype\": \"weekends\",\n \"instructor\": \"\", // Provide instructor ID here\n \"price\": [\n {\n \"currency\": \"NGN\",\n \"offerPrice\": 5000,\n \"standardPrice\": 10000\n }\n ]\n}\n\n\n\n
🔸 instructor should be the valid instructor ID (string). Leave it empty only if it's optional or to be assigned later.
Code: 201 Created
Body Example:
\njsonCopyEdit{\n \"success\": true,\n \"message\": \"Batch created successfully\",\n \"data\": {\n \"_id\": \"674625dfa2305f289d2b4c33\",\n \"name\": \"batch21\",\n \"course\": \"67461cea3d3904acad48fd6e\",\n ...\n }\n}\n\nThis endpoint is used to delete a specific batch from a course in the system. By sending a DELETE request to the specified URL, the user can remove the batch identified by its unique ID.
\nPath Parameters:
\ncourseId: The unique identifier of the course from which the batch is to be deleted. (Example: 67481ebff99edee897525de7)
batchId: The unique identifier of the batch that is to be deleted. (Example: 674c68122ca0195149207c67)
Upon a successful deletion, the server will return a response indicating the success of the operation. The response typically includes:
\nA status code confirming the deletion (e.g., HTTP 204 No Content for a successful delete).
\nA message confirming that the batch has been successfully deleted.
\nMake sure to handle any errors that may occur, such as attempting to delete a batch that does not exist or lacking the necessary permissions.
\n","urlObject":{"path":["courses","67481ebff99edee897525de7","batches","674c68122ca0195149207c67"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"967ae078-f55f-4536-89ad-0b66c3ceaebe"}],"id":"a495d831-ed29-49a3-9e3a-512c1fab986e","_postman_id":"a495d831-ed29-49a3-9e3a-512c1fab986e","description":""},{"name":"FAQ","item":[{"name":"EditFAQ","id":"fda03336-de5b-4e1d-a661-ca56f5754c89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3MjYyNTdhYzk2NTZlMmY2YWRkM2M1NyIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjcyNjI1N2FjOTY1NmUyZjZhZGQzYzU1IiwiaWF0IjoxNzMyMDY4NDcyLCJleHAiOjE3MzIwNzIwNzJ9.dsSmQp0XZVuQ72xQVSaUX8UCj96g7lKxGHgfjpq8ALo","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"question\": \"school\",\r\n \"answer\": \"anginat\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{CoursebaseURL}}/courses/674e584e0a51efbe5a2dee4d/faqs/67505ad13540a054d3487fd0","description":"This endpoint allows you to update an existing FAQ item associated with a specific course.
\nMethod: PUT
Endpoint: {{CoursebaseURL}}/courses/{courseId}/faqs/{faqId}
Replace {courseId} with the unique identifier of the course.
Replace {faqId} with the unique identifier of the FAQ item you wish to update.
The request body must be in JSON format and include the following parameters:
\nquestion (string): The question for the FAQ.
\nanswer (string): The answer corresponding to the FAQ question.
\n{\n \"question\": \"school\",\n \"answer\": \"anginat\"\n}\n\nUpon a successful update, the API will return a response indicating the status of the operation. The expected response format is typically a JSON object confirming the update, which may include the updated FAQ details or a success message.
\nEnsure that you have the necessary permissions to update FAQs for the specified course. The course and FAQ identifiers must be valid and exist in the system.
\n","urlObject":{"path":["courses","674e584e0a51efbe5a2dee4d","faqs","67505ad13540a054d3487fd0"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fda03336-de5b-4e1d-a661-ca56f5754c89"},{"name":"CreateFAQ","id":"76557780-7662-4067-83af-801307ae0f6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3MjYyNTdhYzk2NTZlMmY2YWRkM2M1NyIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjcyNjI1N2FjOTY1NmUyZjZhZGQzYzU1IiwiaWF0IjoxNzMzMzE4OTI1LCJleHAiOjE3MzMzMjI1MjV9.Iz1ZptGe5EyZg_AMZogxltPzNT-Fpx_UG9oKR0rAW68","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"question\": \"what is anginat\",\r\n \"answer\": \"it is unlimited life\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{CoursebaseURL}}/courses/674b13edf99edee89752b29f/faqs","description":"This endpoint allows users to add a Frequently Asked Question (FAQ) to a specific course identified by its unique ID.
\nMethod: POST
\nURL: {{CoursebaseURL}}/courses/{courseId}/faqs
{courseId} with the actual ID of the course (e.g., 674b13edf99edee89752b29f).The request body must be in JSON format and should include the following parameters:
\nquestion (string): The question that users frequently ask about the course.
\nanswer (string): The answer to the frequently asked question.
\n{\n \"question\": \"what is anginat\",\n \"answer\": \"it is unlimited life\"\n}\n\nUpon successfully adding the FAQ, the response will typically include a confirmation of the addition. The structure of the response may vary, but it generally includes:
\nA success message indicating that the FAQ has been added.
\nThe details of the newly created FAQ entry, such as the question and answer provided.
\nMake sure to handle any errors that may occur, such as invalid course IDs or missing parameters in the request body.
\n","urlObject":{"path":["courses","674b13edf99edee89752b29f","faqs"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"76557780-7662-4067-83af-801307ae0f6a"},{"name":"DeleteFAQ","id":"06862bb8-315c-4802-8fdc-54f6894ac064","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NDRkMTIwZDJhY2QxYjBlZjQzMjM0ZCIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjc0NGQxMjBkMmFjZDFiMGVmNDMyMzRiIiwiaWF0IjoxNzM0NjAzNTEyLCJleHAiOjE3MzQ2MDcxMTJ9.yYCQQqDoYHhqAJBERDShYDkes5-zTIKXW7HX3NdbR04","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{CoursebaseURL}}/courses/67484e5cf99edee89752613a/faqs/6763f34dbea467b62b9c44c8","description":"This endpoint allows users to delete a specific FAQ associated with a course. The request is made to the URL that includes both the course ID and the FAQ ID.
\nMethod: DELETE
\nURL: {{CoursebaseURL}}/courses/{courseId}/faqs/{faqId}
courseId (string): The unique identifier of the course from which the FAQ will be deleted.
faqId (string): The unique identifier of the FAQ that needs to be deleted.
Upon successful deletion, the API will return a response indicating the status of the operation. The expected response is typically a confirmation message or status code indicating that the FAQ has been successfully deleted.
\nEnsure that the courseId and faqId provided in the URL are correct, as this will determine the specific FAQ to be deleted.
This operation is irreversible; once an FAQ is deleted, it cannot be recovered.
\nThis endpoint is used to initiate the enrollment process for a specific course. It allows users to provide their contact information and course details to start the enrollment procedure.
\nMethod: POST
URL: {{CoursebaseURL}}/courses/enrollment/initiate
The request body must be in JSON format and include the following parameters:
\nemail (string): The email address of the user enrolling in the course.
\nphone (string): The phone number of the user enrolling in the course.
\ncourseId (string): The unique identifier for the course the user wishes to enroll in.
\nbatchId (string): The unique identifier for the specific batch of the course.
\ncurrency (string): The currency in which the payment will be processed (e.g., \"USD\").
\nstatus (string): The current status of the enrollment (e.g., \"active\").
\nincludeRazorpayFee (boolean): Indicates whether to include the Razorpay fee in the payment calculation.
\nThe response structure will typically include confirmation of the enrollment initiation, which may contain fields such as:
\nsuccess (boolean): Indicates whether the enrollment initiation was successful.
\nmessage (string): A message providing additional information about the enrollment status.
\ndata (object): An object containing any relevant data related to the enrollment process, such as a transaction ID or further instructions.
\nRequest Body Example:
\n{\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"courseId\": \"exampleCourseId\",\n \"batchId\": \"exampleBatchId\",\n \"currency\": \"USD\",\n \"status\": \"active\",\n \"includeRazorpayFee\": \"true\"\n}\n\nThis endpoint is essential for users looking to enroll in courses and manage their enrollment details efficiently.
\n","urlObject":{"path":["courses","enrollment","initiate"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"85dc7a9b-7914-4269-a494-735ff116802c"},{"name":"confirmEnrollment","id":"6541b68b-7a43-4953-b103-3d54dbb5a6fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionId\": \"6760de081282d32465095581\",\r\n \"razorpay_payment_id\": \"pay_PXcdefghijklmno\",\r\n \"razorpay_order_id\": \"order_PXrGouhwEtj3GQ\",\r\n \"razorpay_signature\": \"bc51dfd889f896b9b9ff7193a8ff23d9d19422f8415c36a96c350cd00c4725d4\",\r\n \"email\": \"user@example.com\",\r\n \"phone\": \"1234567890\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{CoursebaseURL}}/courses/enrollment/confirm","description":"This endpoint is used to confirm the enrollment of a user in a course after a payment has been processed. It validates the transaction details provided by the user and ensures that the payment was successful before finalizing the enrollment.
\nThe request must include the following parameters in the JSON body:
\ntransactionId (string): A unique identifier for the transaction, used to track the payment process.
\nrazorpay_payment_id (string): The ID of the payment generated by Razorpay, which confirms the payment was processed.
\nrazorpay_order_id (string): The ID of the order created in Razorpay, linking the payment to the specific course enrollment.
\nrazorpay_signature (string): A cryptographic signature generated by Razorpay to verify the integrity of the payment data.
\nemail (string): The email address of the user enrolling in the course.
\nphone (string): The contact phone number of the user.
\nUpon successful confirmation of the enrollment, the API will return a response indicating the status of the operation. The response will typically include:
\nA success message confirming the enrollment.
\nAny relevant details about the course or user.
\nEnsure that all parameters are provided and correctly formatted to avoid errors during the confirmation process.
\nThe signature must be validated against the payment details to ensure security and prevent fraud.
\nThis endpoint is crucial for maintaining the integrity of course enrollments linked to payment transactions.
\nThis endpoint allows users to verify their enrollment status in a specific course. By providing the user's email along with the course and batch identifiers, the system checks if the user is enrolled in the specified course and batch.
\nemail (string): The email address of the user whose enrollment status is being checked.
\ncourseId (string): The unique identifier for the course.
\nbatchId (string): The unique identifier for the batch within the course.
\nThe response will indicate the enrollment status of the user in the specified course and batch. The exact structure of the response will depend on the implementation but typically includes fields that confirm whether the user is enrolled or not.
\nEnsure that the email provided is associated with an existing user in the system.
\nThe courseId and batchId must correspond to valid entries in the database to receive an accurate response.
\nThis endpoint allows users to enroll in courses by submitting their email address. It is designed to facilitate the enrollment process for users who wish to participate in available courses.
\nMethod: POST
\nEndpoint: {{CoursebaseURL}}/courses/enrollment/enrolled-courses
The request body must be sent in JSON format and should contain the following key:
\nemail (string): The email address of the user enrolling in the courses. This parameter is required.Example Request Body:
\n{\n \"email\": \"user@example.com\"\n}\n\nUpon a successful enrollment, the server will respond with a JSON object containing the details of the enrollment. The structure of the response will typically include:
\nstatus (string): Indicates the success or failure of the enrollment process.
message (string): A message providing additional information about the enrollment status.
data (object): Contains any relevant data regarding the enrolled courses.
Example Response:
\n{\n \"status\": \"success\",\n \"message\": \"Enrollment successful.\",\n \"data\": {\n \"courses\": [\n {\n \"courseId\": \"12345\",\n \"courseName\": \"Introduction to Programming\"\n }\n ]\n }\n}\n\nEnsure that the email provided is valid and corresponds to a user in the system to avoid enrollment errors.
\n","urlObject":{"path":["courses","enrollment","enrolled-courses"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"42ff5d73-7319-48a7-98d3-ed3f017af78f"}],"id":"09b4d2e2-b4ac-4957-8a30-8b9a9251d3eb","_postman_id":"09b4d2e2-b4ac-4957-8a30-8b9a9251d3eb","description":""},{"name":"InstituteService","item":[{"name":"Get Institute Details","id":"cea50238-7465-4f0f-abb3-f0e4dd929a53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{InstituteURL}}/get-institute/68306c98387a027f8a70929b","description":"This endpoint retrieves detailed information about a specific institute identified by its unique ID.
\nMethod: GET
\nURL: {{InstituteURL}}/get-institute/{instituteId}
instituteId (string): The unique identifier of the institute you wish to retrieve information for. In this example, the ID is 68306c98387a027f8a70929b.The response will return a JSON object containing the details of the requested institute. The structure of the response typically includes the following fields:
\nid (string): The unique identifier of the institute.
name (string): The name of the institute.
location (string): The geographical location of the institute.
courses (array): A list of courses offered by the institute, where each course may include additional details such as course name, duration, and fees.
contact (object): An object containing contact details, including phone number and email address.
{\n \"id\": \"68306c98387a027f8a70929b\",\n \"name\": \"Example Institute\",\n \"location\": \"123 Example Street, Example City\",\n \"courses\": [\n {\n \"courseId\": \"course123\",\n \"courseName\": \"Example Course\",\n \"duration\": \"6 months\",\n \"fees\": \"1000\"\n }\n ],\n \"contact\": {\n \"phone\": \"+1234567890\",\n \"email\": \"contact@example.com\"\n }\n}\n\nThis endpoint is useful for obtaining comprehensive information about an institute, which can be utilized for various applications such as displaying details on a website or mobile application.
\n","urlObject":{"path":["get-institute","68306c98387a027f8a70929b"],"host":["{{InstituteURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cea50238-7465-4f0f-abb3-f0e4dd929a53"},{"name":"Update Institute Details","id":"fd0c2647-5e57-4217-986e-14077fe30f5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ODU4MzcwZmUxODFkOTFiOTRkZDNiYyIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjc4NTgzNzBmZTE4MWQ5MWI5NGRkM2JhIiwiaWF0IjoxNzM3MDMwNjY5LCJleHAiOjE3MzcwMzQyNjl9.VypVRtYb0LihdPF3nIez64nsvmT57FAIyYQocBdMU9A","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\":\"taranjeet3412@gmail.com\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{InstituteURL}}/update-details/67858370fe181d91b94dd3ba","description":"This endpoint allows you to update the details of a user identified by a unique ID in the URL. The request is made using the HTTP POST method.
\n{\n \"email\": \"user@example.com\"\n}\n\nUpon a successful request, the response will typically include a confirmation message indicating that the user details have been updated. The exact structure of the response may vary, but it generally includes:
\nstatus (string): Indicates the success or failure of the operation.
\nmessage (string): A descriptive message about the result of the update operation.
\n{\n \"status\": \"success\",\n \"message\": \"User details updated successfully.\"\n}\n\nEnsure that the email provided is valid to avoid errors during the update process.
\n","urlObject":{"path":["update-details","67858370fe181d91b94dd3ba"],"host":["{{InstituteURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd0c2647-5e57-4217-986e-14077fe30f5e"},{"name":"Upload cover or profile","id":"aa9567e4-6765-428a-aec7-4994e2f301fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4NzIyODJiNzYxNTY2YWUyN2E0ZDQxNCIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjczZjkwMDExYzIwOGVkNDg3ZDY1OTMwIiwiaW5zdGl0dXRpb25UeXBlIjoic2Nob29sIiwiaWF0IjoxNzUzMjgxMDQxLCJleHAiOjE3NTMyODQ2NDF9.4g5UaSaCayzKY9ZYfPiq-V5x4TbI4Y6jZgv_0_uuVU8","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"xSs2sNdQn/evergreen_pos1_june2025_homepage_desktop.jpg"},{"key":"type","value":"cover","type":"text"}]},"url":"{{InstituteURL}}/upload/673f90011c208ed487d65930","description":"This endpoint allows users to upload files to the specified institute. It is designed to handle file uploads along with an associated type descriptor.
\nMethod: POST
URL: {{InstituteURL}}/upload/67858370fe181d91b94dd3ba
The request body must be sent as form-data and should contain the following parameters:
file (type: file): The file to be uploaded. This parameter is required.
\ntype (type: text): A string that describes the type of the file being uploaded. This parameter is also required.
\nThe response structure will typically include a confirmation of the upload status, along with any relevant metadata about the uploaded file. The exact response format may vary depending on the implementation but generally includes status codes and messages indicating the success or failure of the upload.
\nEnsure that the request body adheres to the specified format for successful processing of the upload.
\n","urlObject":{"path":["upload","673f90011c208ed487d65930"],"host":["{{InstituteURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa9567e4-6765-428a-aec7-4994e2f301fa"},{"name":"Get Institute Details By Domain","id":"ded303e1-ced4-491f-85a6-fc8a65140e2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"instituteDomain\":\"www.springlearns.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{InstituteURL}}/get-institute-by-domain","description":"This endpoint allows users to retrieve information about an educational institute based on its domain name. It is particularly useful for applications that need to gather details about institutes for various purposes, such as enrollment, information dissemination, or analytics.
\nMethod: POST
\nEndpoint: {{InstituteURL}}/get-institute-by-domain
The request body must be in JSON format and should contain the following parameter:
\nwww.example.com).Example Request Body:
\n{\n \"instituteDomain\": \"www.springlearns.com\"\n}\n\nUpon a successful request, the response will provide detailed information about the institute associated with the specified domain. The structure of the response may include various attributes related to the institute, such as:
\ninstituteId (string): Unique identifier for the institute.
\nname (string): The name of the institute.
\nlocation (string): The geographical location of the institute.
\ncourses (array): A list of courses offered by the institute.
\ncontactInfo (object): Contains details like phone number and email address.
\nTo use this endpoint effectively, ensure that the instituteDomain is correctly formatted and corresponds to an existing institute. The response will provide the necessary information that can be utilized for further processing or display in your application.
This endpoint is used to generate credentials for a student by providing their personal information and desired password settings. It is typically used during the registration or onboarding process to create a new student account.
\nMethod: POST
Endpoint: {{StudentUrl}}/api/student/auth/generate-cred
The request body must be in JSON format and include the following parameters:
\nfirstName (string): The first name of the student.
\nlastName (string): The last name of the student.
\nemail (string): The email address of the student, which will be used for account verification and communication.
\nphoneNumber (string): The phone number of the student for contact purposes.
\ninstitutionId (string): The unique identifier for the institution the student is associated with.
\npassword (string): The desired password for the student account.
\nconfirmPassword (string): A confirmation of the password to ensure it is entered correctly.
\nautoGeneratePassword (boolean): A flag indicating whether to automatically generate a password if set to true.
\n{\n \"firstName\": \"Kalsi\",\n \"lastName\": \"Singh\",\n \"email\": \"taranjeet3412@gmail.com\",\n \"phoneNumber\": \"8368419670\",\n \"institutionId\": \"68306c98387a027f8a70929b\",\n \"password\": \"12345\",\n \"confirmPassword\": \"12345\",\n \"autoGeneratePassword\": false\n}\n\nThe response will contain a confirmation of the credential generation process. The structure of the response may include:
\nstatus (string): Indicates the success or failure of the operation.
\nmessage (string): A descriptive message providing further details about the result of the request.
\ndata (object): Contains additional information related to the generated credentials, such as the student ID or account status.
\n{\n \"status\": \"success\",\n \"message\": \"Credentials generated successfully.\",\n \"data\": {\n \"studentId\": \"123456\",\n \"email\": \"taranjeet3412@gmail.com\"\n }\n}\n\nEnsure that all required fields are provided in the request to avoid errors during credential generation.
\n","urlObject":{"path":["api","student","auth","generate-cred"],"host":["{{StudentUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d4c657b-2bec-4edf-b467-d685290f6835"},{"name":"Login","id":"096ed577-fcf1-47a9-97dc-03647b2aaa84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"emailOrPhoneNumber\":\"tarankhalsa3412@gmail.com\",\r\n \"password\":\"secure\"\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"https://studentapi.anginatlearning.com/api/student/auth/login","description":"This endpoint is used for authenticating a student user by logging them into the system. It validates the provided credentials and returns an authentication token if the login is successful.
\nMethod: POST
\nURL: https://studentapi.anginatlearning.com/api/student/auth/login
The request body must be in JSON format and should contain the following parameters:
\nemailOrPhoneNumber (string): The email address or phone number associated with the student account. This is used to identify the user attempting to log in.
\npassword (string): The password corresponding to the provided email or phone number. This is used to verify the user's identity.
\nUpon a successful login, the API will return a response containing the following structure:
\nstatus (string): Indicates the success or failure of the login attempt.
\ntoken (string): A unique authentication token that can be used for subsequent requests to access protected resources.
\nmessage (string): A message providing additional information about the login attempt, such as success confirmation or error details.
\n{\n \"status\": \"success\",\n \"token\": \"your_auth_token_here\",\n \"message\": \"Login successful\"\n}\n\nThis endpoint is essential for users to gain access to their accounts and utilize the features provided by the application.
\n","urlObject":{"protocol":"https","path":["api","student","auth","login"],"host":["studentapi","anginatlearning","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"096ed577-fcf1-47a9-97dc-03647b2aaa84"},{"name":"Refresh Token","id":"bc0b553e-cf03-4be9-81d8-ce2f41ad8d40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"url":"https://studentapi.anginatlearning.com/api/student/auth/refresh-token","description":"This endpoint allows users to refresh their authentication tokens. It is particularly useful for maintaining user sessions without requiring them to log in again.
\nMethod: POST
Endpoint: http://localhost:3002/api/student/auth/refresh-token
The request body must be sent in application/x-www-form-urlencoded format and should include the following parameters:
Upon a successful request, the server will respond with a JSON object containing the following fields:
\naccessToken (string): The newly generated access token.
\nexpiresIn (integer): The duration (in seconds) until the access token expires.
\n{\n \"accessToken\": \"new_access_token_value\",\n \"expiresIn\": 3600\n}\n\nEnsure that the refresh token is valid and has not expired to receive a successful response.
\n","urlObject":{"protocol":"https","path":["api","student","auth","refresh-token"],"host":["studentapi","anginatlearning","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc0b553e-cf03-4be9-81d8-ce2f41ad8d40"},{"name":"Forgot Password","id":"f950fab2-8e06-4c4c-a03f-7df7679b3cd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"taranjeet3412@gmail.com\",\r\n \"otpType\":\"email\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StudentUrl}}/api/student/auth/forgot-password","description":"This endpoint allows users to initiate the password recovery process by sending a request to receive a One-Time Password (OTP) via email.
\nMethod: POST
\nEndpoint: {{StudentUrl}}/api/student/auth/forgot-password
The request must include a JSON object with the following parameters:
\nemail (string): The email address associated with the user's account. This is required to send the OTP.
\notpType (string): Specifies the type of OTP to be sent. In this case, it should be set to \"email\" to indicate that the OTP will be sent to the user's email address.
\nExample Request Body:
\n{\n \"email\": \"user@example.com\",\n \"otpType\": \"email\"\n}\n\nUpon successful processing of the request, the API will return a response indicating the status of the OTP request. The structure of the response may include:
\nstatus (string): Indicates whether the request was successful or if there was an error.
\nmessage (string): A descriptive message providing additional information regarding the request status.
\nExample Response:
\n{\n \"status\": \"success\",\n \"message\": \"OTP has been sent to your email.\"\n}\n\nEnsure that the email provided is valid and associated with an existing account to successfully receive the OTP.
\nIf the email is not registered, the response may indicate an error, and no OTP will be sent.
\nThis endpoint is used to verify a One-Time Password (OTP) sent to a user's email. It is essential for confirming the user's identity during the authentication process.
\nPOST
http://localhost:3002/api/student/auth/verify-otp
The request body must be in JSON format and should include the following parameters:
\nreceiverId (string): The email address of the user who is verifying the OTP.
\notpType (string): The type of OTP being verified, which in this case is set to \"email\".
\notp (string): The OTP that the user has received and needs to verify.
\n{\n \"receiverId\": \"example@example.com\",\n \"otpType\": \"email\",\n \"otp\": \"123456\"\n}\n\nUpon successful verification, the server will respond with a JSON object indicating the result of the OTP verification. The response will typically include a success message or an error message if the verification fails.
\nEnsure that the OTP provided matches the one sent to the specified email address for successful verification.
\n","urlObject":{"path":["api","student","auth","verify-otp"],"host":["{{StudentUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e275682-576d-4148-9a32-f7ebac2d6541"},{"name":"Reset Password","id":"6da15646-5cd8-4a0a-bb69-5a1d44c3f959","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"newPassword\":\"secure\",\r\n \"confirmPassword\":\"secure\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3002/api/student/auth/reset-password","description":"This endpoint allows users to reset their password. It requires the user to provide a new password and a confirmation of that password to ensure accuracy.
\nMethod: POST
Endpoint: {{StudentUrl}}/api/student/auth/reset-password
Request Body:
The request should include a JSON object with the following parameters:
newPassword (string): The new password that the user wants to set.
confirmPassword (string): A confirmation of the new password to validate that both entries match.
Example Request Body:
\n{\n \"newPassword\": \"secure\",\n \"confirmPassword\": \"secure\"\n}\n\nThe response will indicate the success or failure of the password reset operation. The structure of the response may include:
\nA success message or error details indicating the outcome of the request.
\nAdditional information may be provided based on the implementation.
\nEnsure that both password fields match to successfully reset the password.
\n","urlObject":{"protocol":"http","port":"3002","path":["api","student","auth","reset-password"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"6da15646-5cd8-4a0a-bb69-5a1d44c3f959"},{"name":"Send Otp","id":"b1cc0c9a-b4d7-4332-9fb7-e6bc5438cdb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"tarankhalsa3412@gmail.com\",\r\n \"otpType\":\"email\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://studentapi.anginatlearning.com/api/student/auth/send-otp","description":"This endpoint allows users to initiate the process of authentication by sending a One-Time Password (OTP) to the specified email address. It is primarily used for verifying the identity of students during the login process.
\nMethod: POST
URL: https://studentapi.anginatlearning.com/api/student/auth/send-otp
email (string): The email address to which the OTP will be sent. This should be a valid email format.
\notpType (string): Specifies the type of OTP to be sent. In this case, it is set to \"email\" to indicate that the OTP should be sent via email.
\nOn successful request, the API will respond with a confirmation of the OTP being sent. The exact structure of the response may vary, but it typically includes:
\nA success message indicating that the OTP has been dispatched to the provided email address.
\nAny relevant status codes to indicate the outcome of the request (e.g., success or error).
\nEnsure that the email provided is registered in the system to receive the OTP.
\nIf the email is not registered, the response will indicate an error.
\nThis endpoint is essential for enhancing security during the authentication process by using OTPs.
\nMake sure to handle the OTP verification process after receiving the OTP to complete the authentication flow.
\n","urlObject":{"protocol":"https","path":["api","student","auth","send-otp"],"host":["studentapi","anginatlearning","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1cc0c9a-b4d7-4332-9fb7-e6bc5438cdb4"},{"name":"Fetch Student","id":"4a5ae28a-b4be-480f-90cc-42c2907f075e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"tarankhalsa3412@gmail.com\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{StudentUrl}}/api/student/auth/fetch-student","description":"This endpoint is used to authenticate a student by fetching their information based on the provided email address. It is essential for verifying student credentials and retrieving relevant data from the system.
\nMethod: POST
\nEndpoint: {{StudentUrl}}/api/student/auth/fetch-student
The request body should be in JSON format and must include the following parameter:
\nExample Request Body:
\n{\n \"email\": \"student@example.com\"\n}\n\nUpon a successful request, the server will respond with a JSON object containing the student's authentication status and any relevant data associated with the student. The structure of the response may include:
\nstatus (string): Indicates the success or failure of the authentication process.
\ndata (object): Contains student-specific information, which may include fields such as student ID, name, and enrollment status.
\nmessage (string): A descriptive message providing additional context about the authentication result.
\nExample Response:
\n{\n \"status\": \"success\",\n \"data\": {\n \"studentId\": \"12345\",\n \"name\": \"John Doe\",\n \"enrollmentStatus\": \"active\"\n },\n \"message\": \"Authentication successful.\"\n}\n\nEnsure that the email provided in the request body is valid and corresponds to a registered student in the system for successful authentication.
\n","urlObject":{"path":["api","student","auth","fetch-student"],"host":["{{StudentUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a5ae28a-b4be-480f-90cc-42c2907f075e"},{"name":"Verify Token","id":"9ce5b66d-ffbf-4f1d-8046-a24664662f4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ZDA4ZmI3NzQ2ZjMyYjk4MjBmMDQ5MSIsImVtYWlsIjoidGFyYW5raGFsc2EzNDEyQGdtYWlsLmNvbSIsInBob25lTnVtYmVyIjoiODI4NzE5Mzk5NSIsImlhdCI6MTc0MjgxNzg2NiwiZXhwIjoxNzQyODIxNDY2fQ.8AtzubUvvj58oWFvebS205cxV3SB3B41AI_oonA2aSA","type":"text"}],"url":"{{StudentUrl}}/api/student/auth/verify-token","description":"This endpoint is used to verify the authentication token of a student. It checks if the provided token is valid and has not expired.
\nMethod: GET
\nURL: {{StudentUrl}}/api/student/auth/verify-token
This endpoint does not require any additional parameters in the request body. The token should be included in the request headers as follows:
\nBearer {token}Upon successful verification, the response will include:
\nstatus: Indicates the success or failure of the token verification.
\nmessage: A descriptive message about the result of the verification.
\ndata: Contains any additional information if the token is valid.
\n{\n \"status\": \"success\",\n \"message\": \"Token is valid.\",\n \"data\": {\n \"userId\": \"12345\",\n \"role\": \"student\"\n }\n}\n\nEnsure that the token is correctly formatted and valid.
\nIf the token is invalid or expired, the response will indicate the failure and provide an appropriate message.
\nThis endpoint is crucial for maintaining secure access to student-related resources.
\nThis endpoint allows the user to update the email address associated with a student account.
\nMethod: POST
\nURL: {{StudentUrl}}/api/student/auth/update-email
Content-Type: application/json
\nThe request body must be a JSON object containing the following parameter:
\nUpon a successful request, the API will return a response indicating the status of the email update. The expected response will typically include:
\nA success message confirming that the email has been updated.
\nAny relevant details regarding the update process.
\nEnsure that the email provided is unique and not already in use by another account.
\nIf the email format is invalid or if the email is already associated with another account, an error response will be returned.
\nThis endpoint retrieves a list of students associated with a specific institute. It is designed to provide information about all students enrolled in the institute, which can be useful for administrative purposes or for displaying student data in applications.
\nMethod: GET
\nURL: {{StudentUrl}}/api/student/get-institute-students
This endpoint does not require a request body.
\nThe response will be a JSON object containing the following structure:
\nstatus: A string indicating the success or failure of the request.
\ndata: An array of student objects, where each object may contain:
\nstudentId: A unique identifier for the student.
\nname: The name of the student.
\nemail: The email address of the student.
\nenrollmentDate: The date the student enrolled in the institute.
\n{\n \"status\": \"success\",\n \"data\": [\n {\n \"studentId\": \"12345\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"enrollmentDate\": \"2022-01-15\"\n },\n {\n \"studentId\": \"67890\",\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@example.com\",\n \"enrollmentDate\": \"2022-01-20\"\n }\n ]\n}\n\nThis structure allows clients to easily parse the list of students and access relevant information as needed.
\n","urlObject":{"path":["api","student","get-institute-students"],"host":["{{StudentUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"605dd823-4111-4e9d-8e11-aaf46923f9de"}],"id":"d938765c-93f7-4e6b-a486-d31e6c72bd69","_postman_id":"d938765c-93f7-4e6b-a486-d31e6c72bd69","description":""},{"name":"StudentService","item":[{"name":"Fetch Students","id":"be84b77f-a809-4499-a7eb-1011d0f20e8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"url":"{{StudentUrl}}/api/student/profile/get-students?sectionId=68386800e951ba52db560873&academicClass=68386088ea3f402e8672fb33°ree&semester","description":"This endpoint allows users to get students according to the filteration
\nMethod: POST
Endpoint: {{StudentUrl}}/api/student/profile/assign-students
The request parameters and should contain the following parameters:
\ndegree : id of degree (if institute is college )
\nsection : id of section
\nsemester : id of semester ( if institute is college )
\nacademicClass : id of academicClass
\nThe response will contain the result of the
\nA success message indicating that students are fetched .
\nData of each student.
\nEnsure that the input parameters are correctly formatted to receive a successful response.
\n","urlObject":{"path":["api","student","profile","get-students"],"host":["{{StudentUrl}}"],"query":[{"key":"sectionId","value":"68386800e951ba52db560873"},{"key":"academicClass","value":"68386088ea3f402e8672fb33"},{"key":"degree","value":null},{"key":"semester","value":null}],"variable":[]}},"response":[],"_postman_id":"be84b77f-a809-4499-a7eb-1011d0f20e8c"},{"name":"Update Profile Details","id":"2ffcba61-d812-46ac-8f1f-ea5652894ff2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4MWI1NGQ1Nzg1MzdlZjkzN2RjYjFlNSIsImVtYWlsIjoidGFyYW5qZWV0MzQxMkBnbWFpbC5jb20iLCJwaG9uZU51bWJlciI6IjgzNjg0MTk2NzAiLCJyb2xlIjoic3R1ZGVudCIsImlhdCI6MTc0NjYyMTczNiwiZXhwIjoxNzQ2NjI1MzM2fQ.flO_2gHwwvKls_o5TMOc4Z70jQQ_mY0_h14z4IT6Es0","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"address\":{\r\n \"street\":\"C-58 DDA flats Garhi East Of Kailash\",\r\n \"city\":\"New Delhi\",\r\n \"state\":\"Delhi\",\r\n \"zipCode\":\"110065\"\r\n },\r\n \"gender\":\"male\",\r\n \"nationality\":\"Indian\",\r\n \"religion\":\"Sikhism\",\r\n \"caste\":\"General\",\r\n \"fatherName\":\"Mahan Singh\",\r\n \"motherName\":\"Amrit Kaur\",\r\n \"fatherContact\":\"1234567890\",\r\n \"motherContact\":\"1234567890\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{StudentUrl}}/api/student/profile/update-profile","description":"This endpoint allows student to update their profile data
\nMethod: POST
Endpoint: {{StudentUrl}}/api/student/profile/assign-students
The request parameters and should contain the following parameters:
\naddress:
\nstreet
\ncity
\nstate
\nzipCode
\ngender:
\nnationality
\nreligion
\ncaste
\nfatherName
\nmotherName
\nfatherContact
\nmotherContact
\nThe response will contain the result of the
\nA success message indicating that students are fetched .
\nUpdated Data of student profile
\nEnsure that the input parameters are correctly formatted to receive a successful response.
\n","urlObject":{"path":["api","student","profile","update-profile"],"host":["{{StudentUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ffcba61-d812-46ac-8f1f-ea5652894ff2"},{"name":"Upload Profile Image","id":"7d5ffe4f-9bb3-42df-a459-9391b3fdc33b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ZWQ1ODdjM2E1Nzk1NTA5YTE1NGZiZCIsImVtYWlsIjoidGFyYW5qZWV0MzQxMkBnbWFpbC5jb20iLCJwaG9uZU51bWJlciI6IjgzNjg0MTk2NzAiLCJyb2xlIjoic3R1ZGVudCIsImlhdCI6MTc0NDYyNTE1NSwiZXhwIjoxNzQ0NjI4NzU1fQ.FXo5UgAszH-TDb45AiYS-gO2bh0HeeUbcJyJ6frQWGo","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"profile","type":"file","uuid":"43045c75-8632-4a98-aad5-c13a43048ada","value":null}]},"url":"{{StudentUrl}}/api/student/profile/upload-profile-image","description":"This endpoint allows student to update their profile Image
\nMethod: POST
Endpoint: {{StudentUrl}}/api/student/profile/upload-profile-image
The request form-data body and should contain the following parameters:
\nThe response will contain the result of the
\nA success message indicating that students are fetched .
\nUpdated Data of student profile
\nEnsure that the input parameters are correctly formatted to receive a successful response.
\n","urlObject":{"path":["api","student","profile","upload-profile-image"],"host":["{{StudentUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d5ffe4f-9bb3-42df-a459-9391b3fdc33b"},{"name":"Student History","id":"84754810-f0f9-4abe-8ed0-fe6c08a9bc66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"url":"{{StudentUrl}}/api/student/student-history?id={{studentId}}","description":"This endpoint allows admin to fetch student history.
\nMethod: POST
Endpoint:{{StudentUrl}}/api/student/promote-students
The request should contain the following parameters:
\nid: id of student
\nfield : specific field changed of student in studentProfile user want to get ( fetch student profile to see the variables field )
\nThe response will contain the result of the
\nA success message indicating that students are promoted.
\ndata of student history
\nEnsure that the input parameters are correctly formatted to receive a successful response.
\n","urlObject":{"path":["api","student","student-history"],"host":["{{StudentUrl}}"],"query":[{"key":"id","value":"{{studentId}}"},{"disabled":true,"key":"field","value":"currentSemester"}],"variable":[]}},"response":[],"_postman_id":"84754810-f0f9-4abe-8ed0-fe6c08a9bc66"}],"id":"bbaedb5c-5343-46df-a607-c02f5dd2cdee","_postman_id":"bbaedb5c-5343-46df-a607-c02f5dd2cdee","description":""},{"name":"AdminStudentService","item":[{"name":"initially assign students to class","id":"96039357-0b39-489b-b99f-ef246d0ef474","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"studentIds\":[\"6867d441336089dc3608fec7\",\"68306c98387a027f8a70929b\"],\r\n\r\n \"section\":\"682a6e58822722bcd97db0ab\",\r\n\r\n \"academicClass\":\"{{academicClass}}\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{StudentUrl}}/api/student/profile/assign-students","description":"This endpoint allows users to inititally assign student to section,semester,academic class and degree.
\nMethod: POST
Endpoint: {{StudentUrl}}/api/student/profile/assign-students
The request body must be sent as json and should contain the following parameters:
\nstudentIds : Array of studentId
\ndegree : id of degree (if institute is college )
\nsection : id of section
\nsemester : id of semester ( if institute is college )
\nacademicClass : id of academicClass
\nThe response will contain the result of the
\nA success message indicating that students are assigned to their class.
\nAny additional details that may be relevant to the user.
\nEnsure that the input parameters are correctly formatted to receive a successful response.
\n","urlObject":{"path":["api","student","profile","assign-students"],"host":["{{StudentUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"96039357-0b39-489b-b99f-ef246d0ef474"},{"name":"Admin Update Student Profile","id":"12682035-07e1-43ab-b9e1-4d5eecef6229","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"address\":{\r\n \"street\":\"C-58 DDA flats Garhi East Of Kailash\",\r\n \"city\":\"New Delhi\",\r\n \"state\":\"Delhi\",\r\n \"zipCode\":\"110065\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StudentUrl}}/api/student/admin/update-profile/682db79bdc610c571808be4b","urlObject":{"path":["api","student","admin","update-profile","682db79bdc610c571808be4b"],"host":["{{StudentUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"12682035-07e1-43ab-b9e1-4d5eecef6229"},{"name":"Promote Student","id":"eaeed417-3664-443d-93fb-20abbd011abb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"studentIds\":[\"683e12158758475aabe864fb\",\"683e11d98758475aabe864f4\"],\r\n // \"degree\":\"682a6519468c83e99245d7c0\",\r\n // \"section\":\"682a6e58822722bcd97db0ab\",\r\n \"semester\":\"{{semesterId}}\"\r\n // \"academicClass\":\"{{academicClass}}\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StudentUrl}}/api/student/promote-students","description":"This endpoint allows admin to promote students to further semester or classes.
\nMethod: POST
Endpoint:{{StudentUrl}}/api/student/promote-students
The request and should contain the following parameters:
\nstudentIds : list of student ids (array)
\nsection : optional if student section will not changed
\nsemester : if institute type is college then required while promoting
\nacademicClass : if institute type is college then only required if semester and academic years wants to change , and if institute type is school then it is required
\nThe response will contain the result of the
\nEnsure that the input parameters are correctly formatted to receive a successful response.
\n","urlObject":{"path":["api","student","promote-students"],"host":["{{StudentUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eaeed417-3664-443d-93fb-20abbd011abb"},{"name":"Assign Subject to Students","id":"ce068ce4-9bf1-4790-afbc-b8ec6f769dd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"studentIds\":[\"6867d441336089dc3608fec7\"],\r\n \"studentSubjects\":[\"\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://studentapi.anginatlearning.com/api/student/profile/assign-subjects","urlObject":{"protocol":"https","path":["api","student","profile","assign-subjects"],"host":["studentapi","anginatlearning","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce068ce4-9bf1-4790-afbc-b8ec6f769dd0"},{"name":"Get Student Detials","id":"72f00227-0c51-4499-bb73-0c1446ea9b32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"url":"{{StudentUrl}}/api/student/student-details/:studentId","urlObject":{"path":["api","student","student-details",":studentId"],"host":["{{StudentUrl}}"],"query":[],"variable":[{"type":"any","value":"682db79bdc610c571808be4b","key":"studentId"}]}},"response":[],"_postman_id":"72f00227-0c51-4499-bb73-0c1446ea9b32"}],"id":"ebdde016-f4d8-4b79-b36a-156f80ca5968","_postman_id":"ebdde016-f4d8-4b79-b36a-156f80ca5968","description":""},{"name":"Subject","item":[{"name":"Create Subject","event":[{"listen":"test","script":{"id":"3ab7ae96-2ec1-43b5-bf33-b1b7b04636a3","exec":["pm.test('Status code is 200', function () {"," pm.response.to.have.status(200);","});","pm.test('Subject created', function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.be.true;"," pm.expect(jsonData.message).to.equal('Subject created successfully');"," pm.expect(jsonData.data._id).to.exist;"," pm.environment.set('subjectId', jsonData.data._id);","});"],"type":"text/javascript","packages":{}}}],"id":"e3643794-055d-4816-b02c-c683ed8e0b94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Python basics\",\r\n \"code\": \"PYTHON1\",\r\n \"description\": \"Programmin Language\",\r\n \"degree\": \"682a6519468c83e99245d7c0\", // if institutionType is college\r\n \"credits\": 4, // for college\r\n \"classCode\":\"YEAR_1\", \r\n \"type\": \"theory\",\r\n \"instructors\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"{{InstituteURL}}/subjects","description":"Endpoint: POST /subjects
Description: Creates a new subject under a specific degree. Used to define academic subjects like \"Data Structures\" along with details such as credit value, type, and assigned instructors.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\njsonCopyEdit{\n \"name\": \"Data Structures\",\n \"code\": \"BCA102\",\n \"description\": \"Introduction to Data Structures and Algorithms\",\n \"degree\": \"682a6519468c83e99245d7c0\", //only for college\n \"credits\": 4, //only for college\n \"classCode\":YEAR_1\n \"type\": \"theory\",\n \"instructors\": [\n \"68385ebd62e7fd1157a37fac\"\n ]\n}\n\nStatus: 201 Created
jsonCopyEdit{\n \"message\": \"Subject created successfully\",\n \"data\": {\n \"id\": \"subj_12345\",\n \"name\": \"Data Structures\",\n \"code\": \"BCA102\",\n \"description\": \"Introduction to Data Structures and Algorithms\",\n \"degree\": \"deg_12345\",\n \"credits\": 4,\n \"classCode\": \"YEAR_1\",\n \"type\": \"theory\",\n \"instructors\": [\n \"68385ebd62e7fd1157a37fac\"\n ]\n }\n}\n\nStartFragment
\nEndpoint: GET /subjects/:subjectId
Description: Retrieves detailed information about a specific subject using its unique ID. This includes subject name, code, type, credits, associated degree, and instructors.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\nsubjectId (string) — The unique ID of the subject to fetchStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Subject fetched successfully\",\n \"data\": {\n \"id\": \"subj_12345\",\n \"name\": \"Data Structures\",\n \"code\": \"BCA102\",\n \"description\": \"Introduction to Data Structures and Algorithms\",\n \"degree\": {\n \"id\": \"deg_12345\",\n \"name\": \"Bachelor of Computer Application\"\n },\n \"credits\": 4,\n \"type\": \"theory\",\n \"instructors\": [\n {\n \"id\": \"68385ebd62e7fd1157a37fac\",\n \"name\": \"Prof. John Doe\"\n }\n ]\n }\n}\n\nEndFragment
\n","urlObject":{"path":["subjects","682a7064822722bcd97db0c9"],"host":["{{InstituteURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"978770cf-f0b3-48f7-a390-3a38a6f6cf08"},{"name":"Get All Subjects","event":[{"listen":"test","script":{"id":"71d2c22f-5ffe-47ae-8199-12a6bd6ad44a","exec":["pm.test('Status code is 200', function () {"," pm.response.to.have.status(200);","});","pm.test('Subjects retrieved', function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.be.true;"," pm.expect(jsonData.message).to.equal('Subjects retrieved successfully');"," pm.expect(jsonData.data).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"d08b1fbb-eb3a-445b-b2a3-09e11cbbac63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M"}],"url":"{{InstituteURL}}/subjects","description":"Endpoint: GET /subjects
Description: Fetches a list of all subjects available in the system. Each subject includes details like name, code, degree, credits, type, and assigned instructors.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\nStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Subjects fetched successfully\",\n \"data\": [\n {\n \"id\": \"subj_12345\",\n \"name\": \"Data Structures\",\n \"code\": \"BCA102\",\n \"description\": \"Introduction to Data Structures and Algorithms\",\n \"degree\": {\n \"id\": \"deg_12345\",\n \"name\": \"Bachelor of Computer Application\"\n },\n \"credits\": 4,\n \"type\": \"theory\",\n \"instructors\": [\n {\n \"id\": \"68385ebd62e7fd1157a37fac\",\n \"name\": \"Prof. John Doe\"\n }\n ]\n },\n {\n \"id\": \"subj_67890\",\n \"name\": \"Operating Systems\",\n \"code\": \"BCA201\",\n \"description\": \"Basics of Operating Systems\",\n \"degree\": {\n \"id\": \"deg_12345\",\n \"name\": \"Bachelor of Computer Application\"\n },\n \"credits\": 4,\n \"type\": \"theory\",\n \"instructors\": [\n {\n \"id\": \"68385ebd62e7fd1157a37fac\",\n \"name\": \"Prof. Jane Smith\"\n }\n ]\n }\n ]\n}\n\nEndpoint: PUT /subjects/:subjectId
Description: Updates the details of an existing subject using its unique ID. This allows changes to the subject’s name, code, degree, description, credit value, type, or assigned instructors.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\nsubjectId (string) — The unique ID of the subject to updatejsonCopyEdit{\n \"name\": \"Data Structures\",\n \"code\": \"BCA102\",\n \"description\": \"Introduction to Data Structures and Algorithms\",\n \"degree\": \"682a6519468c83e99245d7c0\",\n \"credits\": 4,\n \"type\": \"theory\",\n \"instructors\": [\n \"68385ebd62e7fd1157a37fac\"\n ]\n}\n\nStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Subject updated successfully\",\n \"data\": {\n \"id\": \"subj_12345\",\n \"name\": \"Data Structures\",\n \"code\": \"BCA102\",\n \"description\": \"Introduction to Data Structures and Algorithms\",\n \"degree\": \"deg_12345\",\n \"credits\": 4,\n \"type\": \"theory\",\n \"instructors\": [\n \"68385ebd62e7fd1157a37fac\"\n ]\n }\n}\n\nEndpoint: DELETE /subjects/:subjectId
Description: Deletes a subject from the system using its unique ID. This action removes the subject and disassociates it from any linked degrees or instructors.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\nsubjectId (string) — The unique ID of the subject to deleteStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Subject deleted successfully\"\n}\n\nEndpoint: POST /timetables
Description: Creates a timetable entry for a specific subject, class, and instructor. Includes scheduling details such as weekly hours, class times, and room assignments.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\njsonCopyEdit{\n \"academicClass\": \"682a6b79dba413c9db166687\",\n \"section\": \"682a6e58822722bcd97db0ab\",\n \"subject\": \"682a7064822722bcd97db0c9\",\n \"degree\": \"682a6519468c83e99245d7c0\",\n \"semester\": \"{{semesterId}}\",\n \"instructor\": \"{{instructorId}}\",\n \"weeklyHours\": 4,\n \"scheduleDetails\": [\n {\n \"day\": \"Monday\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"room\": \"Lecture Hall 1\"\n },\n {\n \"day\": \"Wednesday\",\n \"startTime\": \"14:00\",\n \"endTime\": \"15:00\",\n \"room\": \"Lecture Hall 1\"\n }\n ],\n \"notes\": \"Theory only - no lab\"\n}\n\nStatus: 201 Created
jsonCopyEdit{\n \"message\": \"Timetable created successfully\",\n \"data\": {\n \"id\": \"tt_12345\",\n \"academicClass\": \"class_001\",\n \"section\": \"sec_01\",\n \"subject\": \"subj_123\",\n \"degree\": \"deg_001\",\n \"semester\": \"sem_001\",\n \"instructor\": \"inst_001\",\n \"weeklyHours\": 4,\n \"scheduleDetails\": [\n {\n \"day\": \"Monday\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"room\": \"Lecture Hall 1\"\n },\n {\n \"day\": \"Wednesday\",\n \"startTime\": \"14:00\",\n \"endTime\": \"15:00\",\n \"room\": \"Lecture Hall 1\"\n }\n ],\n \"notes\": \"Theory only - no lab\"\n }\n}\n\nEndpoint: GET /api/timetables/:timetableId
Description: Retrieves detailed information about a specific timetable entry using its unique ID. Includes associated class, subject, instructor, schedule details, and notes.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\ntimetableId (string) — The unique ID of the timetable to retrieveStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Timetable fetched successfully\",\n \"data\": {\n \"id\": \"tt_12345\",\n \"academicClass\": {\n \"id\": \"class_001\",\n \"name\": \"BCA 1st Year\"\n },\n \"section\": {\n \"id\": \"sec_01\",\n \"name\": \"A\"\n },\n \"subject\": {\n \"id\": \"subj_123\",\n \"name\": \"Data Structures\"\n },\n \"degree\": {\n \"id\": \"deg_001\",\n \"name\": \"Bachelor of Computer Application\"\n },\n \"semester\": {\n \"id\": \"sem_001\",\n \"number\": 1\n },\n \"instructor\": {\n \"id\": \"inst_001\",\n \"name\": \"Prof. John Doe\"\n },\n \"weeklyHours\": 4,\n \"scheduleDetails\": [\n {\n \"day\": \"Monday\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"room\": \"Lecture Hall 1\"\n },\n {\n \"day\": \"Wednesday\",\n \"startTime\": \"14:00\",\n \"endTime\": \"15:00\",\n \"room\": \"Lecture Hall 1\"\n }\n ],\n \"notes\": \"Theory only - no lab\"\n }\n}\n\nEndpoint: GET /timetables
Description: Retrieves a list of all timetable entries created in the system. Each entry includes details like class, section, subject, instructor, schedule, and notes.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\nStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Timetables fetched successfully\",\n \"data\": [\n {\n \"id\": \"tt_12345\",\n \"academicClass\": {\n \"id\": \"class_001\",\n \"name\": \"BCA 1st Year\"\n },\n \"section\": {\n \"id\": \"sec_01\",\n \"name\": \"A\"\n },\n \"subject\": {\n \"id\": \"subj_123\",\n \"name\": \"Data Structures\"\n },\n \"degree\": {\n \"id\": \"deg_001\",\n \"name\": \"Bachelor of Computer Application\"\n },\n \"semester\": {\n \"id\": \"sem_001\",\n \"number\": 1\n },\n \"instructor\": {\n \"id\": \"inst_001\",\n \"name\": \"Prof. John Doe\"\n },\n \"weeklyHours\": 4,\n \"scheduleDetails\": [\n {\n \"day\": \"Monday\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"room\": \"Lecture Hall 1\"\n },\n {\n \"day\": \"Wednesday\",\n \"startTime\": \"14:00\",\n \"endTime\": \"15:00\",\n \"room\": \"Lecture Hall 1\"\n }\n ],\n \"notes\": \"Theory only - no lab\"\n },\n {\n \"id\": \"tt_67890\",\n \"academicClass\": {\n \"id\": \"class_002\",\n \"name\": \"BBA 1st Year\"\n },\n \"section\": {\n \"id\": \"sec_02\",\n \"name\": \"B\"\n },\n \"subject\": {\n \"id\": \"subj_456\",\n \"name\": \"Business Communication\"\n },\n \"degree\": {\n \"id\": \"deg_002\",\n \"name\": \"Bachelor of Business Administration\"\n },\n \"semester\": {\n \"id\": \"sem_002\",\n \"number\": 1\n },\n \"instructor\": {\n \"id\": \"inst_002\",\n \"name\": \"Prof. Jane Smith\"\n },\n \"weeklyHours\": 3,\n \"scheduleDetails\": [\n {\n \"day\": \"Tuesday\",\n \"startTime\": \"12:00\",\n \"endTime\": \"13:00\",\n \"room\": \"Lecture Hall 2\"\n }\n ],\n \"notes\": \"Communication Skills Module\"\n }\n ]\n}\n\nEndpoint: PUT /timetables/:timetableId
Description: Updates an existing timetable entry using its unique ID. You can modify the subject, instructor, schedule details, or any other field in the timetable.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\ntimetableId (string) — The unique ID of the timetable to updatejsonCopyEdit{\n \"academicClass\": \"682a6b79dba413c9db166687\",\n \"section\": \"682a6e58822722bcd97db0ab\",\n \"subject\": \"682a7064822722bcd97db0c9\",\n \"degree\": \"682a6519468c83e99245d7c0\",\n \"semester\": \"{{semesterId}}\",\n \"instructor\": \"{{instructorId}}\",\n \"weeklyHours\": 4,\n \"scheduleDetails\": [\n {\n \"day\": \"Monday\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"room\": \"Lecture Hall 1\"\n },\n {\n \"day\": \"Wednesday\",\n \"startTime\": \"14:00\",\n \"endTime\": \"15:00\",\n \"room\": \"Lecture Hall 1\"\n }\n ],\n \"notes\": \"Theory only - no lab\"\n}\n\nStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Timetable updated successfully\",\n \"data\": {\n \"id\": \"tt_12345\",\n \"academicClass\": \"class_001\",\n \"section\": \"sec_01\",\n \"subject\": \"subj_123\",\n \"degree\": \"deg_001\",\n \"semester\": \"sem_001\",\n \"instructor\": \"inst_001\",\n \"weeklyHours\": 4,\n \"scheduleDetails\": [\n {\n \"day\": \"Monday\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"room\": \"Lecture Hall 1\"\n },\n {\n \"day\": \"Wednesday\",\n \"startTime\": \"14:00\",\n \"endTime\": \"15:00\",\n \"room\": \"Lecture Hall 1\"\n }\n ],\n \"notes\": \"Theory only - no lab\"\n }\n}\n\nEndpoint: DELETE /api/timetables/:timetableId
Description: Deletes a timetable entry from the system using its unique ID. This action removes the entire timetable, including associated schedule details.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\ntimetableId (string) — The unique ID of the timetable to deleteStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Timetable deleted successfully\"\n}\n\nEndpoint: POST /classes
Description: Creates a new academic class under a specified institution and degree. This is used to represent a year-level or grade (e.g., \"BCA Year 1\" or \"Class 10\") within a school or college.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\njsonCopyEdit{\n \"institution\": \"67cdc7d7c99c0010b0803c74\",\n \"name\": \"BCA Year 1\",\n \"classCode\": \"YEAR_1\",\n \"degree\": \"682a6519468c83e99245d7c0\"\n}\n\nclassCode:tsCopyEdit[\n 'NURSERY', 'KG', 'CLASS_1', 'CLASS_2', 'CLASS_3', 'CLASS_4',\n 'CLASS_5', 'CLASS_6', 'CLASS_7', 'CLASS_8', 'CLASS_9',\n 'CLASS_10', 'CLASS_11', 'CLASS_12'\n]\n\ntsCopyEdit[\n 'YEAR_1', 'YEAR_2', 'YEAR_3', 'YEAR_4', 'YEAR_5'\n]\n\nStatus: 201 Created
jsonCopyEdit{\n \"message\": \"Class created successfully\",\n \"data\": {\n \"id\": \"class_12345\",\n \"institution\": \"inst_001\",\n \"name\": \"BCA Year 1\",\n \"classCode\": \"YEAR_1\",\n \"degree\": \"deg_001\"\n }\n}\n\nEndpoint:
\nbashCopyEditGET http://localhost:3000/api/institute/classes/682a6b79dba413c9db166687\n\nDescription:
\nFetch a single academic class by its unique classId.
Path Parameters:
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Response: 200 OK
jsonCopyEdit{\n \"_id\": \"class_id\",\n \"institution\": \"institution_id\",\n \"name\": \"BCA Year 1\",\n \"classCode\": \"YEAR_1\",\n \"degree\": \"degree_id\",\n}\n\nErrors:
\n401 Unauthorized – Missing or invalid token
404 Not Found – Class with provided ID does not exist
Endpoint:
\nbashCopyEditGET http://localhost:3000/api/institute/classes\n\nDescription:
\nRetrieve a complete list of all academic classes available in the system.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Response: 200 OK
jsonCopyEdit[\n {\n \"_id\": \"64f1b8c9f15c9e7b620f19ab\",\n \"institution\": \"64f1b88ef15c9e7b620f19a2\",\n \"name\": \"BCA Year 1\",\n \"classCode\": \"YEAR_1\",\n \"degree\": \"64f1b893f15c9e7b620f19a5\",\n \"createdAt\": \"2025-06-01T12:00:00.000Z\",\n \"updatedAt\": \"2025-06-01T12:00:00.000Z\"\n },\n {\n \"_id\": \"64f1b8c9f15c9e7b620f19ac\",\n \"institution\": \"64f1b88ef15c9e7b620f19a2\",\n \"name\": \"BCA Year 2\",\n \"classCode\": \"YEAR_2\",\n \"degree\": \"64f1b893f15c9e7b620f19a5\",\n \"createdAt\": \"2025-06-01T12:00:00.000Z\",\n \"updatedAt\": \"2025-06-01T12:00:00.000Z\"\n }\n]\n\nErrors:
\n401 Unauthorized – If the auth token is missing or invalid
500 Internal Server Error – On server issues
Endpoint:
\nbashCopyEditPUT http://localhost:3000/api/institute/classes/682a6b79dba413c9db166687\n\nDescription:
\nUpdate the details of a specific academic class by its ID.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Request Body:
\njsonCopyEdit{\n \"institution\": \"67cdc7d7c99c0010b0803c74\",\n \"name\": \"BCA Year 1\",\n \"classCode\": \"YEAR_1\",\n \"degree\": \"682a6519468c83e99245d7c0\"\n}\n\n\n\n
💡 classCode can be one of the following based on education type:
School: NURSERY, KG, CLASS_1 to CLASS_12
College: YEAR_1 to YEAR_5
Response: 200 OK
jsonCopyEdit{\n \"message\": \"Academic class updated successfully.\",\n \"class\": {\n \"_id\": \"682a6b79dba413c9db166687\",\n \"institution\": \"67cdc7d7c99c0010b0803c74\",\n \"name\": \"BCA Year 1\",\n \"classCode\": \"YEAR_1\",\n \"degree\": \"682a6519468c83e99245d7c0\",\n \"updatedAt\": \"2025-07-01T12:34:56.789Z\",\n \"createdAt\": \"2025-06-01T10:00:00.000Z\"\n }\n}\n\nErrors:
\n400 Bad Request – Missing or invalid fields
401 Unauthorized – Invalid/missing auth token
404 Not Found – If the class with classId doesn’t exist
500 Internal Server Error – On server failure
Endpoint:
\nbashCopyEditDELETE http://localhost:3000/api/institute/api/classes/682a6b79dba413c9db166687\n\nDescription:
\nDeletes a specific academic class by its ID.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Path Parameters:
\nclassId (string) — ID of the academic class to deleteResponse: 200 OK
jsonCopyEdit{\n \"message\": \"Academic class deleted successfully.\"\n}\n\nErrors:
\n401 Unauthorized – Invalid or missing access token
404 Not Found – Class not found with the given ID
500 Internal Server Error – Server-side error
Endpoint:
\nbashCopyEditPOST {{InstituteURL}}/sections\n\nDescription:
\nCreates a new section under a specific academic class.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Request Body:
\njsonCopyEdit{\n \"academicClass\": \"682a6b79dba413c9db166687\", // Required: ID of the academic class\n \"name\": \"Section A\", // Required: Name of the section\n \"section\": \"A\", // Required: Short code or identifier (e.g., \"A\", \"B\")\n \"description\": \"BCA Section A\" // Optional: Description of the section\n // Add subject in section if institute type is school otherwise if institute type is college add subjects in semester\n \"subjects\":[\n \"\"\n ]\n //add subject IDs\n}\n\nResponse: 201 Created
jsonCopyEdit{\n \"message\": \"Section created successfully.\",\n \"section\": {\n \"_id\": \"64eea1991f1f4f001ea65314\",\n \"name\": \"Section A\",\n \"section\": \"A\",\n \"description\": \"BCA Section A\",\n \"academicClass\": \"64eea1991f1f4f001ea65300\",\n \"createdAt\": \"2025-07-01T12:00:00.000Z\",\n \"updatedAt\": \"2025-07-01T12:00:00.000Z\"\n }\n}\n\nErrors:
\n400 Bad Request – Missing or invalid fields
401 Unauthorized – Invalid or missing access token
500 Internal Server Error – Something went wrong on the server
Endpoint:
\nbashCopyEditGET http://localhost:3000/api/institute/sections/682a6e58822722bcd97db0ab\n\nDescription:
\nFetches details of a specific section using its unique ID.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Path Parameters:
\nsectionId (string) – The ID of the section to retrieveResponse: 200 OK
jsonCopyEdit{\n \"_id\": \"64eea1991f1f4f001ea65314\",\n \"name\": \"Section A\",\n \"section\": \"A\",\n \"description\": \"BCA Section A\",\n \"academicClass\": {\n \"_id\": \"64eea1991f1f4f001ea65300\",\n \"name\": \"BCA Year 1\",\n \"classCode\": \"YEAR_1\"\n },\n \"createdAt\": \"2025-07-01T12:00:00.000Z\",\n \"updatedAt\": \"2025-07-01T12:00:00.000Z\"\n}\n\nErrors:
\n404 Not Found – If the section ID does not exist
401 Unauthorized – Missing or invalid token
500 Internal Server Error – Server-side error
Endpoint:
\nbashCopyEditGET http://localhost:3000/api/institute/sections\n\nDescription:
\nRetrieves a list of all sections available in the system.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Query Parameters:
None
Response: 200 OK
jsonCopyEdit[\n {\n \"_id\": \"64eea1991f1f4f001ea65314\",\n \"name\": \"Section A\",\n \"section\": \"A\",\n \"description\": \"BCA Section A\",\n \"academicClass\": {\n \"_id\": \"64eea1991f1f4f001ea65300\",\n \"name\": \"BCA Year 1\",\n \"classCode\": \"YEAR_1\"\n },\n \"createdAt\": \"2025-07-01T12:00:00.000Z\",\n \"updatedAt\": \"2025-07-01T12:00:00.000Z\"\n },\n {\n \"_id\": \"64eea1991f1f4f001ea65315\",\n \"name\": \"Section B\",\n \"section\": \"B\",\n \"description\": \"BCA Section B\",\n \"academicClass\": {\n \"_id\": \"64eea1991f1f4f001ea65300\",\n \"name\": \"BCA Year 1\",\n \"classCode\": \"YEAR_1\"\n },\n \"createdAt\": \"2025-07-01T12:30:00.000Z\",\n \"updatedAt\": \"2025-07-01T12:30:00.000Z\"\n }\n]\n\nErrors:
\n401 Unauthorized – Missing or invalid token
500 Internal Server Error – Server-side issue
Endpoint:
\nbashCopyEditPUT http://localhost:3000/api/institute/sections/682a6e58822722bcd97db0ab\n\nDescription:
\nUpdates the details of an existing section.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Request Parameters:
\nsectionId – The ID of the section to update (passed in the URL path)Request Body:
\njsonCopyEdit{\n \"academicClass\": \"682a6b79dba413c9db166687\",\n \"name\": \"Section A\",\n \"section\": \"A\",\n \"description\": \"BCA Section A\"\n}\n\nResponse: 200 OK
jsonCopyEdit{\n \"message\": \"Section updated successfully\",\n \"data\": {\n \"_id\": \"682a6e58822722bcd97db0ab\",\n \"academicClass\": \"682a6b79dba413c9db166687\",\n \"name\": \"Section A\",\n \"section\": \"A\",\n \"description\": \"BCA Section A\",\n \"updatedAt\": \"2025-07-01T12:00:00.000Z\"\n }\n}\n\nErrors:
\n400 Bad Request – Validation error (e.g. missing required fields)
401 Unauthorized – Missing or invalid token
404 Not Found – Section ID not found
500 Internal Server Error – Server-side issue
Endpoint:
\nbashCopyEditDELETE http://localhost:3000/api/institute/sections/682a6e58822722bcd97db0ab\n\nDescription:
\nDeletes a section by its ID.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Path Parameter:
\nsectionId – The unique ID of the section to deleteResponse: 200 OK
jsonCopyEdit{\n \"message\": \"Section deleted successfully\"\n}\n\nErrors:
\n401 Unauthorized – Token is missing or invalid
404 Not Found – Section not found
500 Internal Server Error – Server error while deleting
Endpoint:
\nbashCopyEditPOST http://localhost:3000/api/institute/api/institute/levels\n\nDescription:
\nCreates a new academic level for an institution (e.g., \"CBSE Secondary\").
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Request Body:
\njsonCopyEdit{\n \"institution\": \"67858370fe181d91b94dd3ba\", // Institution ID\n \"levelNumber\": 2, // Level ordering number\n \"name\": \"CBSE Secondary\", // Name of the level\n \"category\": \"secondary\" // Category: primary | secondary | higher | college | etc.\n}\n\nResponse: 201 Created
jsonCopyEdit{\n \"message\": \"Level created successfully\",\n \"data\": {\n \"_id\": \"levelId\",\n \"institution\": \"67858370fe181d91b94dd3ba\",\n \"levelNumber\": 2,\n \"name\": \"CBSE Secondary\",\n \"category\": \"secondary\",\n \"createdAt\": \"...\",\n \"updatedAt\": \"...\"\n }\n}\n\nErrors:
\n400 Bad Request – Missing or invalid fields
401 Unauthorized – No token or invalid token
500 Internal Server Error – Server issue
Endpoint:
\nbashCopyEditGET http://localhost:3000/api/institute/api/institute/levels\n\nDescription:
\nFetches all academic levels (e.g., \"Primary\", \"Secondary\") for the logged-in institution.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Query Parameters:
No query parameters required
Response: 200 OK
jsonCopyEdit{\n \"message\": \"Levels fetched successfully\",\n \"data\": [\n {\n \"_id\": \"levelId1\",\n \"institution\": \"67858370fe181d91b94dd3ba\",\n \"levelNumber\": 1,\n \"name\": \"CBSE Primary\",\n \"category\": \"primary\",\n \"createdAt\": \"...\",\n \"updatedAt\": \"...\"\n },\n {\n \"_id\": \"levelId2\",\n \"institution\": \"67858370fe181d91b94dd3ba\",\n \"levelNumber\": 2,\n \"name\": \"CBSE Secondary\",\n \"category\": \"secondary\",\n \"createdAt\": \"...\",\n \"updatedAt\": \"...\"\n }\n ]\n}\n\nErrors:
\n401 Unauthorized – No token or invalid token
500 Internal Server Error – Server issue
Endpoint:
\nbashCopyEditPOST http://localhost:3000/api/institute/create/semesters\n\nDescription:
\nCreates a new semester for a specific academic class and degree, along with associated subjects.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Request Body:
\njsonCopyEdit{\n \"degree\": \"682a6519468c83e99245d7c0\",\n \"academicClass\": \"682a6b79dba413c9db166687\",\n \"semesterNumber\": 2,\n \"startDate\": \"2025-07-01T00:00:00Z\",\n \"endDate\": \"2025-12-30T23:59:59Z\",\n \"courses\": [\n \"682a7064822722bcd97db0c9\"\n ]\n}\n\nField Descriptions:
\ndegree – (string) ID of the degree the semester belongs to
academicClass – (string) ID of the academic class
semesterNumber – (number) The semester number (e.g., 1, 2, 3)
startDate – (string) Start date of the semester in ISO format
endDate – (string) End date of the semester in ISO format
courses – (array of strings) List of subject/course IDs for this semester
Response: 201 Created
jsonCopyEdit{\n \"message\": \"Semester created successfully\",\n \"data\": {\n \"_id\": \"semesterId\",\n \"degree\": \"degreeId\",\n \"academicClass\": \"classId\",\n \"semesterNumber\": 2,\n \"startDate\": \"2025-07-01T00:00:00Z\",\n \"endDate\": \"2025-12-30T23:59:59Z\",\n \"courses\": [\"subjectId\"],\n \"createdAt\": \"...\",\n \"updatedAt\": \"...\"\n }\n}\n\nErrors:
\n400 Bad Request – Missing or invalid required fields
401 Unauthorized – Token is missing or invalid
500 Internal Server Error – Server issue
Endpoint:
\narduinoCopyEditGET http://localhost:3000/api/institute/get/semesters\n\nDescription:
\nFetches a paginated list of semesters filtered by academicClass.
Authentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Query Parameters:
\nExample Request:
\nbashCopyEditGET http://localhost:3000/api/institute/get/semesters?page=1&limit=10&academicClass=682a6b79dba413c9db166687\n\nSuccess Response: 200 OK
jsonCopyEdit{\n \"total\": 4,\n \"page\": 1,\n \"limit\": 10,\n \"data\": [\n {\n \"_id\": \"semesterId1\",\n \"degree\": \"degreeId\",\n \"academicClass\": \"classId\",\n \"semesterNumber\": 1,\n \"startDate\": \"2025-01-01T00:00:00Z\",\n \"endDate\": \"2025-06-30T23:59:59Z\",\n \"courses\": [\"subjectId1\", \"subjectId2\"],\n \"createdAt\": \"...\",\n \"updatedAt\": \"...\"\n },\n ...\n ]\n}\n\nErrors:
\n400 Bad Request – Missing or invalid query parameters
401 Unauthorized – Token is missing or invalid
500 Internal Server Error – Server issue
Endpoint:
\nbashCopyEditPUT http://localhost:3000/api/institute/semester/{{semesterId}}\n\nDescription:
\nUpdates an existing semester with new details such as class, dates, and courses.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Path Parameters:
\nRequest Body:
\njsonCopyEdit{\n \"degree\": \"682a6519468c83e99245d7c0\",\n \"academicClass\": \"682a6b79dba413c9db166687\",\n \"semesterNumber\": 2,\n \"startDate\": \"2025-07-01T00:00:00Z\",\n \"endDate\": \"2025-12-30T23:59:59Z\",\n \"courses\": [\n \"682a7064822722bcd97db0c9\"\n ]\n}\n\nBody Fields:
\nExample Request:
\nbashCopyEditPUT http://localhost:3000/api/institute/semester/64b456abc123456789d4a321\n\njsonCopyEdit{\n \"degree\": \"64b1234567890abcdef12345\",\n \"academicClass\": \"64b0987654321fedcba09876\",\n \"semesterNumber\": 2,\n \"startDate\": \"2025-07-01T00:00:00Z\",\n \"endDate\": \"2025-12-30T23:59:59Z\",\n \"courses\": [\"64c123456789abcdef01234\"]\n}\n\nSuccess Response: 200 OK
jsonCopyEdit{\n \"message\": \"Semester updated successfully\",\n \"data\": {\n \"_id\": \"64b456abc123456789d4a321\",\n \"degree\": \"64b1234567890abcdef12345\",\n \"academicClass\": \"64b0987654321fedcba09876\",\n \"semesterNumber\": 2,\n \"startDate\": \"2025-07-01T00:00:00Z\",\n \"endDate\": \"2025-12-30T23:59:59Z\",\n \"courses\": [\"64c123456789abcdef01234\"]\n }\n}\n\nError Responses:
\n400 Bad Request – Invalid or missing fields
404 Not Found – Semester ID not found
401 Unauthorized – Missing or invalid token
500 Internal Server Error – Server issue
Endpoint:
\nbashCopyEditDELETE http://localhost:3000/api/institute/api/semesters/{{semesterId}}\n\nDescription:
\nDeletes an existing semester by its ID. This action is irreversible and will remove all associations of the semester with classes, courses, and other linked entities.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Path Parameters:
\nRequest Body:
None
Example Request:
\nbashCopyEditDELETE http://localhost:3000/api/institute/api/semesters/64b456abc123456789d4a321\n\nSuccess Response: 200 OK
jsonCopyEdit{\n \"message\": \"Semester deleted successfully\"\n}\n\nError Responses:
\n400 Bad Request – Invalid semester ID format
404 Not Found – Semester not found
401 Unauthorized – Missing or invalid token
500 Internal Server Error – Unexpected server error
Endpoint:
\nbashCopyEditGET http://localhost:3000/api/institute/semester/{{semesterId}}\n\nDescription:
\nFetches detailed information of a specific semester by its unique ID, including its class, degree, courses, and duration.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
Path Parameters:
\nRequest Body:
None
Example Request:
\nbashCopyEditGET http://localhost:3000/api/institute/semester/64b456abc123456789d4a321\n\nSuccess Response: 200 OK
jsonCopyEdit{\n \"_id\": \"64b456abc123456789d4a321\",\n \"degree\": \"64a111def456abc123d0e456\",\n \"academicClass\": \"64b444abc111456789d0c123\",\n \"semesterNumber\": 2,\n \"startDate\": \"2025-07-01T00:00:00.000Z\",\n \"endDate\": \"2025-12-30T23:59:59.000Z\",\n \"courses\": [\n {\n \"_id\": \"64c1234abc5678ef90d1a123\",\n \"name\": \"Computer Networks\",\n \"code\": \"CS302\"\n }\n ],\n \"createdAt\": \"2025-06-30T12:00:00.000Z\",\n \"updatedAt\": \"2025-07-01T10:30:00.000Z\"\n}\n\nError Responses:
\n400 Bad Request – Invalid semester ID format
404 Not Found – Semester not found
401 Unauthorized – Missing or invalid token
500 Internal Server Error – Server encountered an error
Endpoint:
\nbashCopyEditPOST http://localhost:3000/api/institute/attendance/create-session\n\nDescription:
\nCreates a new attendance session for a specific class, subject, instructor, and timetable schedule.
\nAuthentication:
\n🔒 Requires Authorization HeaderAuthorization: Bearer
jsonCopyEdit{\n \"timetable\": \"683d81868fa5b7d8c9aaa80a\",\n \"instructor\": \"68385ebd62e7fd1157a37fac\",\n \"academicClass\": \"68386088ea3f402e8672fb33\",\n \"section\": \"68386800e951ba52db560873\",\n \"subject\": \"683864e13a90dae160281638\",\n \"scheduleDetail\": {\n \"day\": \"Monday\",\n \"startTime\": \"12:00\",\n \"endTime\": \"13:00\"\n },\n \"date\": \"2025-05-29\"\n}\n\n201 CreatedjsonCopyEdit{\n \"message\": \"Attendance session created successfully\",\n \"data\": {\n \"_id\": \"683e8b7c9c9f96bca1b31d7e\",\n \"date\": \"2025-05-29\",\n \"scheduleDetail\": {\n \"day\": \"Monday\",\n \"startTime\": \"12:00\",\n \"endTime\": \"13:00\"\n },\n \"timetable\": \"683d81868fa5b7d8c9aaa80a\",\n \"instructor\": \"68385ebd62e7fd1157a37fac\",\n \"academicClass\": \"68386088ea3f402e8672fb33\",\n \"section\": \"68386800e951ba52db560873\",\n \"subject\": \"683864e13a90dae160281638\",\n \"createdAt\": \"2025-07-01T11:00:00.000Z\"\n }\n}\n\n400 Bad Request – Missing or invalid required fields
401 Unauthorized – Token is missing or invalid
409 Conflict – Session already exists for the given time/date
500 Internal Server Error – Server-side issue
URL:
\nbashCopyEdithttp://localhost:3000/api/institute/attendance\n\nMethod:GET
Query Parameters:
\nExample Request:
\nhttpCopyEditGET http://localhost:3000/api/institute/attendance?subjectId=683864e13a90dae160281638§ionId=68386800e951ba52db560873\n\nResponse:
\njsonCopyEdit[\n {\n \"_id\": \"sessionId\",\n \"date\": \"2025-05-29\",\n \"subject\": {\n \"_id\": \"683864e13a90dae160281638\",\n \"name\": \"Mathematics\"\n },\n \"section\": {\n \"_id\": \"68386800e951ba52db560873\",\n \"name\": \"Section A\"\n },\n \"attendanceRecords\": [\n {\n \"student\": \"studentId\",\n \"status\": \"Present\"\n }\n ]\n }\n]\n\nURL: {{InstituteURL}}/attendance/mark
\nMethod:POST
Request Body:
\njsonCopyEdit{\n \"session\": \"{{sessionId}}\",\n \"attendance\": [\n {\n \"student\": \"683e11d98758475aabe864f4\",\n \"status\": \"PRESENT\"\n },\n {\n \"student\": \"683e12158758475aabe864fb\",\n \"status\": \"ABSENT\"\n }\n ]\n}\n\nBody Parameters:
\nExample Request:
\njsonCopyEdit{\n \"session\": \"683e11058758475aabe864dd\",\n \"attendance\": [\n {\n \"student\": \"683e11d98758475aabe864f4\",\n \"status\": \"PRESENT\"\n },\n {\n \"student\": \"683e12158758475aabe864fb\",\n \"status\": \"ABSENT\"\n }\n ]\n}\n\nSuccess Response:
\njsonCopyEdit{\n \"message\": \"Attendance marked successfully\",\n \"markedCount\": 2\n}\n\nURL:
\nbashCopyEdit{{CoursebaseURL}}/media\n\nMethod:POST
Content-Type:multipart/form-data
Form Data Parameters:
\nExample (form-data):
\nyamlCopyEditinstitution: 6726257ac9656e2f6add3c55 \nmodule: 683b77d63c2e678e2b28626c \ntitle: Calculus Basics \ntype: video \nisDownloadable: false \nvisibility: enrolledOnly \nexpiresIn: 3600 \nfile: <attach a file>\n\nSuccess Response:
\njsonCopyEdit{\n \"message\": \"Media uploaded successfully\",\n \"mediaId\": \"68402c568b8a85f0a64ff099\"\n}\n\nStartFragment
\nURL: /api/media/:id?institution=inst_id
\nMethod:GET
URL Parameters:
\nQuery Parameters:
\nExample Request:
\nbashCopyEditGET http://localhost:3000/api/media/68402c568b8a85f0a64ff099?institution=6726257ac9656e2f6add3c55\n\nSuccess Response:
\njsonCopyEdit{\n \"media\": {\n \"_id\": \"68402c568b8a85f0a64ff099\",\n \"title\": \"Calculus Basics\",\n \"type\": \"video\",\n \"isDownloadable\": false,\n \"visibility\": \"enrolledOnly\",\n \"expiresIn\": 3600,\n \"institution\": \"6726257ac9656e2f6add3c55\",\n \"module\": \"683b77d63c2e678e2b28626c\",\n \"url\": \"https://example.com/path-to-video.mp4\"\n }\n}\n\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","course","courses","media","68905a6ce20b87c84f3550fe"],"host":["studentapi","anginatlearning","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"91cac10a-fadc-46e0-beb0-d857ee156544"},{"name":"Get Media by Module","id":"849dc2a6-619b-4403-8a13-9be5a3fab93c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"url":"{{CoursebaseURL}}/media/module/:moduleid","description":"URL: /api/media/module/:moduleId?institution=inst_id
\nMethod:GET
bashCopyEditGET http://localhost:3000/api/media/module/683b77d63c2e678e2b28626c?institution=6726257ac9656e2f6add3c55\n\njsonCopyEdit{\n \"media\": [\n {\n \"_id\": \"68402c568b8a85f0a64ff099\",\n \"title\": \"Calculus Basics\",\n \"type\": \"video\",\n \"isDownloadable\": false,\n \"visibility\": \"enrolledOnly\",\n \"expiresIn\": 3600,\n \"institution\": \"6726257ac9656e2f6add3c55\",\n \"module\": \"683b77d63c2e678e2b28626c\",\n \"url\": \"https://example.com/path-to-video.mp4\"\n },\n {\n \"_id\": \"68402cabc123456789abcdef\",\n \"title\": \"Integration Practice\",\n \"type\": \"pdf\",\n \"isDownloadable\": true,\n \"visibility\": \"public\",\n \"expiresIn\": null,\n \"institution\": \"6726257ac9656e2f6add3c55\",\n \"module\": \"683b77d63c2e678e2b28626c\",\n \"url\": \"https://example.com/resources/integration-practice.pdf\"\n }\n ]\n}\n\nEndpoint:PUT /api/media/:id?institution=inst_id
Description:
\nUpdates a media resource by its id for a given institution.
Required ✅ (e.g. Admin or Instructor token)
\njsonCopyEdit{\n \"title\": \"Updated Calculus Basics\",\n \"isDownloadable\": true\n}\n\nStatus: 200 OK
jsonCopyEdit{\n \"success\": true,\n \"message\": \"Media updated successfully\",\n \"data\": {\n \"_id\": \"media_id\",\n \"title\": \"Updated Calculus Basics\",\n \"isDownloadable\": true,\n ...\n }\n}\n\n400 Bad Request – Missing or invalid parameters.
404 Not Found – Media not found.
401 Unauthorized – Invalid or missing auth token.
Endpoint:DELETE /api/media/:id?institution=inst_id
Description:
\nDeletes a specific media resource using its id for a given institution.
Required ✅ (e.g. Admin or Instructor token)
\nNo request body required.
\nStatus: 200 OK
jsonCopyEdit{\n \"success\": true,\n \"message\": \"Media deleted successfully\"\n}\n\n400 Bad Request – Missing or invalid parameters.
404 Not Found – Media not found.
401 Unauthorized – Invalid or missing auth token.
Endpoint:POST {{CoursebaseURL}}/assignments
Creates a new assignment and associates it with a course, target (e.g., batch), and a media resource.
\nRequired ✅ (e.g., Instructor or Admin token)
\njsonCopyEdit{\n \"media\": \"68589456b748ecb70ea8f7b5\", // Media ID (e.g., video or document)\n \"context\": \"online\", // Context of assignment (e.g., \"online\" / \"offline\")\n \"target\": \"67cf5fc7b28fdd8eccca67db\", // Target entity (e.g., batch ID)\n \"contextRef\": \"Course.batches\", // Reference path for the target\n \"institution\": \"6726257ac9656e2f6add3c55\", // Institution ID\n \"course\": \"67cf5fc7b28fdd8eccca67d9\" // Course ID\n}\n\nStatus: 201 Created
jsonCopyEdit{\n \"success\": true,\n \"data\": {\n \"_id\": \"6858a5d2b748ecb70ea8f801\",\n \"media\": \"68589456b748ecb70ea8f7b5\",\n \"context\": \"online\",\n \"target\": \"67cf5fc7b28fdd8eccca67db\",\n \"contextRef\": \"Course.batches\",\n \"institution\": \"6726257ac9656e2f6add3c55\",\n \"course\": \"67cf5fc7b28fdd8eccca67d9\",\n \"createdAt\": \"2025-07-01T15:00:00.000Z\",\n ...\n }\n}\n\n400 Bad Request – Invalid body or missing fields.
401 Unauthorized – Auth token is invalid or missing.
404 Not Found – Provided course or media ID does not exist.
Endpoint:GET {{CoursebaseURL}}/media/:mediaId?institution=6726257ac9656e2f6add3c55
Fetches all assignments linked to a specific media resource within a given institution.
\nRequired ✅ (e.g., Instructor/Admin token)
\n:mediaId — The ID of the media whose assignments you want to fetch.institution — The ID of the institution.httpCopyEditGET /media/68589456b748ecb70ea8f7b5?institution=6726257ac9656e2f6add3c55\n\nStatus: 200 OK
jsonCopyEdit{\n \"success\": true,\n \"data\": [\n {\n \"_id\": \"6858a5d2b748ecb70ea8f801\",\n \"media\": \"68589456b748ecb70ea8f7b5\",\n \"context\": \"online\",\n \"target\": \"67cf5fc7b28fdd8eccca67db\",\n \"contextRef\": \"Course.batches\",\n \"institution\": \"6726257ac9656e2f6add3c55\",\n \"course\": \"67cf5fc7b28fdd8eccca67d9\",\n \"createdAt\": \"2025-07-01T15:00:00.000Z\",\n ...\n }\n ]\n}\n\n400 Bad Request — Missing institution or invalid ID format.
404 Not Found — No assignments found for the given media.
401 Unauthorized — Invalid or missing auth token.
Endpoint:GET {{CoursebaseURL}}/media/:mediaId?institution=6726257ac9656e2f6add3c55
Fetches all assignments linked to a specific media resource within a given institution.
\nRequired ✅ (e.g., Instructor/Admin token)
\n:mediaId — The ID of the media whose assignments you want to fetch.institution — The ID of the institution.httpCopyEditGET /media/68589456b748ecb70ea8f7b5?institution=6726257ac9656e2f6add3c55\n\nStatus: 200 OK
jsonCopyEdit{\n \"success\": true,\n \"data\": [\n {\n \"_id\": \"6858a5d2b748ecb70ea8f801\",\n \"media\": \"68589456b748ecb70ea8f7b5\",\n \"context\": \"online\",\n \"target\": \"67cf5fc7b28fdd8eccca67db\",\n \"contextRef\": \"Course.batches\",\n \"institution\": \"6726257ac9656e2f6add3c55\",\n \"course\": \"67cf5fc7b28fdd8eccca67d9\",\n \"createdAt\": \"2025-07-01T15:00:00.000Z\",\n ...\n }\n ]\n}\n\n400 Bad Request — Missing institution or invalid ID format.
404 Not Found — No assignments found for the given media.
401 Unauthorized — Invalid or missing auth token.
Endpoint:DELETE /api/assignments/:id?institution=inst_id
Deletes a specific assignment by its ID within the context of a specified institution.
\nRequired ✅ (Instructor/Admin)
\n:id — The ID of the assignment to delete.institution — The ID of the institution (required).httpCopyEditDELETE /api/assignments/6858a5d2b748ecb70ea8f801?institution=6726257ac9656e2f6add3c55\n\nStatus: 200 OK
jsonCopyEdit{\n \"success\": true,\n \"message\": \"Assignment deleted successfully\"\n}\n\n400 Bad Request — Missing or invalid institution query param.
404 Not Found — Assignment not found.
401 Unauthorized — Invalid or missing auth token.
StartFragment
\nEndpoint:POST /api/course/courses/modules
Creates a new module for a course.
\nRequired ✅ (Instructor/Admin)
\njsonCopyEdit{\n \"title\": \"Algebra\",\n \"description\": \"Introduction to algebra\",\n \"moduleNumber\": 1\n}\n\nhCopyEditPOST /api/course/courses/modules\nContent-Type: application/json\n{\n \"title\": \"Algebra\",\n \"description\": \"Introduction to algebra\",\n \"moduleNumber\": 1\n}\n\nStatus: 201 Created
jsonCopyEdit{\n \"success\": true,\n \"message\": \"Module created successfully\",\n \"data\": {\n \"_id\": \"6849f43c1b9f0cbd2e9b013a\",\n \"title\": \"Algebra\",\n \"description\": \"Introduction to algebra\",\n \"moduleNumber\": 1\n }\n}\n\n400 Bad Request — Missing required fields.
401 Unauthorized — Invalid or missing auth token.
500 Internal Server Error — Server issue while creating module.
EndFragment
\n","urlObject":{"path":["course","courses","modules"],"host":["{{CoursebaseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6226da71-ba63-4fd4-844b-60e1652f30e6"},{"name":"Get All Modules","event":[{"listen":"test","script":{"id":"1f48de4b-f5d7-4541-8c52-5a81f8369e34","exec":["pm.test('Status code is 200', function () {"," pm.response.to.have.status(200);","});","pm.test('Modules retrieved', function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.be.true;"," pm.expect(jsonData.data).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"8b5b9af5-2075-4d40-a3af-8d64d7de6589","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"url":"http://localhost:3000/api/course/courses/modules","description":"StartFragment
\nEndpoint:GET http://localhost:3000/api/institute/api/modules
Retrieves a list of all course modules available under the institution or platform.
\nOptional (can be restricted to admins/instructors if needed)
\nhttpCopyEditGET /api/modules\n\nStatus: 200 OK
jsonCopyEdit{\n \"success\": true,\n \"data\": [\n {\n \"_id\": \"6849f43c1b9f0cbd2e9b013a\",\n \"title\": \"Algebra\",\n \"description\": \"Introduction to algebra\",\n \"moduleNumber\": 1\n },\n {\n \"_id\": \"684a1523a5e4bbd21a67f91c\",\n \"title\": \"Calculus\",\n \"description\": \"Basics of calculus\",\n \"moduleNumber\": 2\n }\n ]\n}\n\n500 Internal Server Error — Something went wrong on the server.EndFragment
\n","urlObject":{"protocol":"http","port":"3000","path":["api","course","courses","modules"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"8b5b9af5-2075-4d40-a3af-8d64d7de6589"},{"name":"Get Module by ID","event":[{"listen":"test","script":{"id":"0acbe9ce-ca4b-4099-bbf1-a43ce3b27835","exec":["pm.test('Status code is 200', function () {"," pm.response.to.have.status(200);","});","pm.test('Module retrieved', function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.be.true;"," pm.expect(jsonData.data._id).to.equal(pm.environment.get('moduleId'));","});"],"type":"text/javascript","packages":{}}}],"id":"8f0a80d5-e0f6-4ed1-8567-2082b4073254","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3Y2RjN2Q3Yzk5YzAwMTBiMDgwM2M3NiIsInJvbGUiOiJhZG1pbiIsImluc3RpdHV0aW9uIjoiNjdjZGM3ZDdjOTljMDAxMGIwODAzYzc0IiwiaWF0IjoxNzQ3NjA4MzE0LCJleHAiOjE3NDc2MTE5MTR9.ieiCy4C8OlMq10IIcq8fzPQJcMQHhqh05mibjWcOr5M","type":"text"}],"url":"https://studentapi.anginatlearning.com/api/course/courses/modules/688dd32ae20b87c84f036a3a","description":"Endpoint:GET http://localhost:3000/api/institute/api/modules/{{moduleId}}
Fetches detailed information of a specific module using its ID.
\nOptional (based on your system requirements)
\nhttpCopyEditGET /api/modules/6849f43c1b9f0cbd2e9b013a\n\nStatus: 200 OK
jsonCopyEdit{\n \"success\": true,\n \"data\": {\n \"_id\": \"6849f43c1b9f0cbd2e9b013a\",\n \"title\": \"Algebra\",\n \"description\": \"Introduction to algebra\",\n \"moduleNumber\": 1\n }\n}\n\n404 Not Found — Module not found.
500 Internal Server Error — Server-side error.
Endpoint: POST http://localhost:3000/api/institute/degrees
Description: Adds a new academic degree to the system. Typically used by admins to define degree programs such as BCA, BSc, BBA, etc.
Authorization: ✅ Required (Bearer Token in Authorization header)
pgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\njsonCopyEdit{\n \"name\": \"Bachelor of Computer Application\",\n \"shortCode\": \"BCA\",\n \"duration\": 3,\n \"totalSemesters\": 6,\n \"description\": \"Undergraduate degree in Computer Application\"\n}\n\nStatus: 201 Created
jsonCopyEdit{\n \"message\": \"Degree created successfully\",\n \"data\": {\n \"id\": \"deg_12345\",\n \"name\": \"Bachelor of Computer Application\",\n \"shortCode\": \"BCA\",\n \"duration\": 3,\n \"totalSemesters\": 6,\n \"description\": \"Undergraduate degree in Computer Application\"\n }\n}\n\nEndpoint: GET /degrees/:degreeId
Description: Retrieves the details of a specific academic degree using its unique ID. Useful for viewing a single degree's information such as name, duration, and description.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\ndegreeId (string) — The unique ID of the degree to fetchStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Degree fetched successfully\",\n \"data\": {\n \"id\": \"deg_12345\",\n \"name\": \"Bachelor of Computer Application\",\n \"shortCode\": \"BCA\",\n \"duration\": 3,\n \"totalSemesters\": 6,\n \"description\": \"Undergraduate degree in Computer Application\"\n }\n}\n\nEndpoint: GET /api/institute/degrees
Description: Fetches a list of all academic degrees created under the institute. Typically used to display available degree programs to admins or users with access.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\nStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Degrees fetched successfully\",\n \"data\": [\n {\n \"id\": \"deg_12345\",\n \"name\": \"Bachelor of Computer Application\",\n \"shortCode\": \"BCA\",\n \"duration\": 3,\n \"totalSemesters\": 6,\n \"description\": \"Undergraduate degree in Computer Application\"\n },\n {\n \"id\": \"deg_67890\",\n \"name\": \"Bachelor of Business Administration\",\n \"shortCode\": \"BBA\",\n \"duration\": 3,\n \"totalSemesters\": 6,\n \"description\": \"Undergraduate degree in Business Administration\"\n }\n ]\n}\n\nEndpoint: PUT /degrees/:degreeId
Description: Updates the details of an existing academic degree using its ID. This can be used to modify fields such as name, shortcode, duration, total semesters, or description.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\ndegreeId (string) — The unique ID of the degree to updatejsonCopyEdit{\n \"name\": \"Bachelor of Computer Application\",\n \"shortCode\": \"BCA\",\n \"duration\": 3,\n \"totalSemesters\": 6,\n \"description\": \"Undergraduate degree in Computer Application\"\n}\n\nStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Degree updated successfully\",\n \"data\": {\n \"id\": \"deg_12345\",\n \"name\": \"Bachelor of Computer Application\",\n \"shortCode\": \"BCA\",\n \"duration\": 3,\n \"totalSemesters\": 6,\n \"description\": \"Undergraduate degree in Computer Application\"\n }\n}\n\nEndpoint: DELETE /degrees/:degreeId
Description: Deletes an existing academic degree from the system using its unique ID. This action is typically restricted to admin users.
Authorization: ✅ Required (Bearer Token in Authorization header)
\npgsqlCopyEditAuthorization: Bearer <your_token_here>\nContent-Type: application/json\n\ndegreeId (string) — The unique ID of the degree to deleteStatus: 200 OK
jsonCopyEdit{\n \"message\": \"Degree deleted successfully\"\n}\n\n