{ "openapi": "3.0.0", "info": { "title": "My API", "description": "Description of my API", "version": "3.0.0" }, "servers": [ { "url": "/", "description": "API Server" } ], "paths": { "/api/guest/guest_account_create": { "post": { "tags": [ "Guest user" ], "summary": "Generate a guest token", "description": "Creates a unique guest user and generates an authentication token for that user.", "operationId": "c902cf8c44e3b25e4accc4023668d8b9", "responses": { "201": { "description": "Guest token generated successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Guest token generated successfully." }, "token": { "type": "string", "example": "your_generated_token_here" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid request or failure in generating token", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while generating the token." } }, "type": "object" } }, "type": "object" } } } } } } }, "/api/user/token_verify": { "get": { "tags": [ "Authentication" ], "summary": "Check if user token is valid", "description": "This endpoint checks if the authenticated user's token is valid, whether the user's profile is active, and whether the user has the appropriate role.", "operationId": "CheckUserValidToken", "responses": { "200": { "description": "Valid user with active profile and correct role.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "User exists and is valid." }, "error": { "type": "string", "example": null } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized or inactive user.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" }, "error": { "type": "string", "example": null } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error occurred.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/tutor/login": { "post": { "tags": [ "Authentication" ], "summary": "Login with mobile number or email and password", "operationId": "0f7114ec6de3ee2c8326ed123915cf88", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email_or_mobile", "password", "device_token_id" ], "properties": { "email_or_mobile": { "type": "string", "example": "tutor@example.com or 1234554321" }, "password": { "type": "string", "example": "123456" }, "device_token_id": { "type": "string", "example": "your_device_token_here" } }, "type": "object" } } } }, "responses": { "200": { "description": "Login successful", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "token": { "type": "string", "example": "your_generated_token_here" }, "message": { "type": "string", "example": "Login successful" } }, "type": "object" } } } }, "401": { "description": "Invalid credentials", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid credentials" } }, "type": "object" } } } }, "500": { "description": "Internal server error" } } } }, "/api/tutor/dashboard": { "get": { "tags": [ "tutor" ], "summary": "Get counts and details for the dashboard", "description": "Returns counts of test series, students, instructors, and additional details for dashboard.", "operationId": "b810e00265fe8a56a68a7ea877b3b6ea", "responses": { "200": { "description": "Successfully retrieved dashboard details", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "properties": { "totalTestseries": { "type": "integer", "example": 10 }, "totalStudents": { "type": "integer", "example": 150 }, "totalInstructors": { "type": "integer", "example": 20 }, "popularInstructors": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "John Doe" }, "rating": { "type": "number", "format": "float", "example": 4.5 }, "reviews": { "type": "integer", "example": 50 }, "total_students": { "type": "integer", "example": 100 }, "total_testseries": { "type": "integer", "example": 10 }, "description": { "type": "string", "example": "Top instructor" }, "image": { "type": "string", "example": "image.jpg" } }, "type": "object" } }, "recentTestSeries": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Test Series 1" }, "testseries_image": { "type": "string", "example": "testseries_image.jpg" }, "tutor_name": { "type": "string", "example": "John Doe" }, "tutor_image": { "type": "string", "example": "tutor_image.jpg" } }, "type": "object" } }, "notifications": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "message": { "type": "string", "example": "Notification message" }, "image": { "type": "string", "example": "notification_image.jpg" }, "role_id": { "type": "integer", "example": 3 } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized (if the user is not authenticated)", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "User not authenticated" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/tutor/student_add": { "post": { "tags": [ "tutor" ], "summary": "Student Add", "description": "Allow Tutor to add new student.", "operationId": "16c755275515b357924a08c37a693304", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "mobile_no" ], "properties": { "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "johnDoe@example1.com" }, "mobile_no": { "type": "integer", "example": "1234567890" } }, "type": "object" } } } }, "responses": { "200": { "description": "Student successfully created", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Student added successfully" }, "student": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "johnDoe@example1.com" }, "mobile_no": { "type": "integer", "example": "1234567890" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Validation error message" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/tutor/testseries_add": { "post": { "tags": [ "tutor" ], "summary": "Add New Testseries By Tutor", "description": "Allows a tutor to add new Testseries with Details.", "operationId": "2ad2dc2193a1cb978cf9559627d73672", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "category_id", "testseries_name", "instructions", "total_time", "negative_marks", "per_ques_mark", "attempt_per_stud", "price" ], "properties": { "category_id": { "type": "integer", "example": "75" }, "testseries_name": { "type": "string", "example": "Hindi Test" }, "instructions": { "type": "string", "example": "Do any 5 Questions!" }, "total_time": { "type": "integer", "example": "30" }, "negative_marks": { "type": "integer", "example": "1" }, "per_ques_mark": { "type": "integer", "example": "4" }, "attempt_per_stud": { "type": "integer", "example": "20" }, "price": { "type": "integer", "example": "50" }, "testseries_image": { "type": "string", "example": "hinditest.jpg" } }, "type": "object" } } } }, "responses": { "200": { "description": "Test Series successfully created", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "testseries_image_path": { "type": "string", "example": "/upload/testseries/" }, "message": { "type": "string", "example": "Test Series added successfully" }, "testseries": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "category_id": { "type": "integer", "example": "75" }, "testseries_name": { "type": "string", "example": "Hindi Tets" }, "instructions": { "type": "string", "example": "Do any 5 Questions!" }, "total_time": { "type": "integer", "example": "30" }, "negative_marks": { "type": "integer", "example": 1 }, "per_ques_mark": { "type": "integer", "example": "4" }, "attempt_per_stud": { "type": "integer", "example": "20" }, "price": { "type": "integer", "example": "50" }, "tseries_verif_status": { "type": "string", "enum": [ "pending", "approved", "rejected" ], "example": "approved" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Validation error message" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/master/otp/{master}/{new_value}": { "get": { "tags": [ "Master" ], "summary": "Handle OTP for master actions", "description": "Handles OTP actions like updating the master OTP or fetching the current master OTP and updating the OTP limit.", "operationId": "061bfac8414a0d0b492bb798694225e6", "parameters": [ { "name": "master", "in": "path", "description": "The action to perform. 'change-master-otp' to update OTP, 'change-otp-limit' to update OTP limit, 'check-master-otp' to fetch OTP.", "required": true, "schema": { "type": "string" } }, { "name": "new_value", "in": "path", "description": "The new OTP to update the master OTP or the new OTP limit (only required if action is 'change-master-otp' or 'change-otp-limit').", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully performed OTP action", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Master OTP updated successfully" }, "data": { "properties": { "master_otp": { "type": "string", "example": "123456" }, "otp_limit": { "type": "integer", "example": 5 } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request: invalid parameters or missing fields. Reasons include: \n * - 'New OTP is required for update' when attempting to change OTP without providing a new OTP. \n * - 'New OTP limit is required for update' when attempting to change OTP limit without providing a new limit. \n * - 'Invalid action' when the master parameter does not match expected values.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "New OTP is required for update" } }, "type": "object" } } } }, "404": { "description": "Firm not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Firm not found" } }, "type": "object" } } } } } } }, "/api/user/send-otp": { "post": { "tags": [ "Authentication" ], "summary": "Send OTP to a mobile number", "operationId": "09e8d247071626fb045d6bf8612285e9", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "mobile_no" ], "properties": { "mobile_no": { "type": "string", "example": "1111122211" } }, "type": "object" } } } }, "responses": { "200": { "description": "OTP sent successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "OTP sent" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "The mobile_no field is required." } }, "type": "object" } } } }, "500": { "description": "Internal server error" } } } }, "/api/user/login": { "post": { "tags": [ "Authentication" ], "summary": "Login with mobile number or email and password", "operationId": "943b8d8a930ae18c067650c761ec62aa", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email_or_mobile", "password", "device_token_id" ], "properties": { "email_or_mobile": { "type": "string", "example": "user@example.com or 1234554321" }, "password": { "type": "string", "example": "123456" }, "device_token_id": { "type": "string", "example": "your_device_token_here" } }, "type": "object" } } } }, "responses": { "200": { "description": "Login successful", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "token": { "type": "string", "example": "your_generated_token_here" }, "message": { "type": "string", "example": "Login successful" } }, "type": "object" } } } }, "401": { "description": "Invalid credentials", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid credentials" } }, "type": "object" } } } }, "500": { "description": "Internal server error" } } } }, "/api/user/google-login": { "post": { "tags": [ "Authentication" ], "summary": "Login using Google", "description": "Logs in a user using Google login, validates the Google ID token, and returns an API token. If the user doesn't exist, it creates a new one.", "operationId": "googleUserLogin", "requestBody": { "description": "Google login credentials and token", "required": true, "content": { "application/json": { "schema": { "required": [ "name", "email", "google_id", "device_token_id" ], "properties": { "name": { "description": "User's full name", "type": "string", "example": "John Doe" }, "email": { "description": "User's email address", "type": "string", "example": "john@example.com" }, "google_id": { "description": "Google user's unique ID", "type": "string", "example": "110169484474386276334" }, "device_token_id": { "description": "The user's device token for push notifications", "type": "string", "example": "device_token_here" } }, "type": "object" } } } }, "responses": { "200": { "description": "Login successful, token returned", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Google Login successful" }, "token": { "type": "string", "example": "1|klj39sdfksjf02sjdk9sdf..." } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "The google_id field is required." } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Invalid Google token", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Invalid Google token." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Internal server error" }, "error": { "type": "string", "example": "Exception message here..." } }, "type": "object" } }, "type": "object" } } } } } } }, "/api/user/forgot-password": { "post": { "tags": [ "Authentication" ], "summary": "Request password reset OTP", "operationId": "003baf8020ef8d107e55f06a2249bf99", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "contact" ], "properties": { "contact": { "type": "string", "example": "user@example.com or 1234554321" } }, "type": "object" } } } }, "responses": { "200": { "description": "OTP sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "OTP sent successfully" } }, "type": "object" } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "User not found" } }, "type": "object" } } } }, "500": { "description": "Internal server error" } } } }, "/api/user/verify_forget_password_otp": { "post": { "tags": [ "Authentication" ], "summary": "Verify OTP and issue token", "operationId": "b7ecdaa4034123d3c27538e810eaebab", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "contact", "otp" ], "properties": { "contact": { "type": "string", "example": "user@example.com or 1234554321" }, "otp": { "type": "string", "example": "123456" } }, "type": "object" } } } }, "responses": { "200": { "description": "OTP verified successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "OTP verified successfully" }, "token": { "type": "string", "example": "your_generated_token_here" } }, "type": "object" } } } }, "400": { "description": "Invalid OTP or expired OTP", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid OTP or OTP expired" } }, "type": "object" } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "User not found" } }, "type": "object" } } } }, "500": { "description": "Internal server error" } } } }, "/api/user/logout": { "post": { "tags": [ "Authentication" ], "summary": "Logout the authenticated user", "operationId": "baa65e0a01c3c6a75c3988c45273ac49", "responses": { "200": { "description": "Logout successful", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Logout successful" } }, "type": "object" } } } }, "401": { "description": "User not authenticated", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "User not authenticated" } }, "type": "object" } } } }, "500": { "description": "Internal server error" } }, "security": [ { "sanctum": [] } ] } }, "/api/user/change-password": { "post": { "tags": [ "user" ], "summary": "Change user password", "operationId": "02cc4fc31f7e4d9bfc2f2a0f4a342430", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "new_password", "new_password_confirmation" ], "properties": { "new_password": { "type": "string", "example": "newpassword123" }, "new_password_confirmation": { "type": "string", "example": "newpassword123" } }, "type": "object" } } } }, "responses": { "200": { "description": "Password changed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Password changed successfully" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "The new password and confirmation password must match." } }, "type": "object" } } } }, "401": { "description": "Unauthorized (if the user is not authenticated)" } }, "security": [ { "sanctum": [] } ] } }, "/api/user/change-email-mobile": { "post": { "tags": [ "Authentication" ], "summary": "Change user Email/Mobile No", "operationId": "ff1cd677a5104405b3681c9bdb6d6f7a", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email_or_mobile", "flag_type" ], "properties": { "email_or_mobile": { "type": "string", "example": "user@example.com or 1234554321" }, "flag_type": { "type": "string", "enum": [ "email", "mobile" ], "example": "email" } }, "type": "object" } } } }, "responses": { "200": { "description": "OTP sent successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "OTP sent successfully." } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error or user already exists", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "User Already Exists with Same Email." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing the request." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/verify-otp-change-email-mobile": { "post": { "tags": [ "Authentication" ], "summary": "Verify OTP for changing Email or Mobile No", "operationId": "e6ad4a29a1c42087ef42c750a8748896", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email_or_mobile", "otp", "flag_type" ], "properties": { "email_or_mobile": { "type": "string", "example": "user@example.com or 1234554321" }, "otp": { "type": "string", "example": "123456" }, "flag_type": { "type": "string", "enum": [ "email", "mobile" ], "example": "email" } }, "type": "object" } } } }, "responses": { "200": { "description": "Verification successful", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Email verified successfully" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error or invalid OTP", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Invalid or expired OTP" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "User already exists with same email or mobile", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "User Already Exists with Same Email Address" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Internal server error" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/current": { "get": { "tags": [ "user" ], "summary": "Get details of the currently logged-in user", "description": "Returns the authenticated user's details if the request is authenticated.", "operationId": "23e656dc5ad23601fb3f5671e4fab54f", "responses": { "200": { "description": "Successfully retrieved user details", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "user": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john@example.com" }, "mobile_no": { "type": "string", "example": "1234567890" }, "address": { "type": "string", "example": "123 Main St" }, "classname": { "type": "string", "example": "100" }, "is_pass_create": { "type": "integer", "example": "1 or 0" }, "facebook": { "type": "string", "example": "https://facebook.com/johndoe" }, "twitter": { "type": "string", "example": "https://twitter.com/johndoe" }, "instagram": { "type": "string", "example": "https://instagram.com/johndoe" }, "linkedin": { "type": "string", "example": "https://linkedin.com/in/johndoe" }, "student": { "properties": { "school": { "type": "string", "example": "ABC School" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "User not authenticated", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "User not authenticated" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/update": { "post": { "tags": [ "user" ], "summary": "Update user details", "operationId": "0cf4407b3187d88d843998499729b84d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "johndoe@example.com" }, "mobile_no": { "type": "string", "example": "1234567890" }, "father_name": { "type": "string", "example": "Robert Doe" }, "mother_name": { "type": "string", "example": "Jane Doe" }, "school": { "type": "string", "example": "ABC School" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "address": { "type": "string", "example": "123 Main St" }, "classname": { "type": "string", "example": "100" } }, "type": "object" } } } }, "responses": { "200": { "description": "User details updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "User details updated successfully" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Validation error message" } }, "type": "object" } } } }, "401": { "description": "Unauthorized (if the user is not authenticated)" } }, "security": [ { "sanctum": [] } ] } }, "/api/user/profile_image_upload": { "get": { "tags": [ "user" ], "summary": "Upload User Profile Image", "description": "Uploads a profile image for the authenticated user and saves the file name in the database.", "operationId": "uploadUserProfile", "parameters": [ { "name": "image", "in": "query", "description": "The name of the image file to be uploaded", "required": true, "schema": { "type": "string", "example": "profile_picture.png" } } ], "responses": { "200": { "description": "Image uploaded successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Image uploaded successfully" }, "user_image": { "type": "string", "example": "profile_picture.png" }, "user_image_path": { "type": "string", "example": "/upload/student" }, "current_user_image": { "type": "string", "example": "profile_picture.png" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "No image file provided" } }, "type": "object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred: [error_message]" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/dashboard": { "get": { "tags": [ "user" ], "summary": "Get counts and details for the dashboard", "description": "Returns counts of test series, students, instructors, and additional details for dashboard.", "operationId": "6d814fe6cc6e65f533498d3b52d6163e", "responses": { "200": { "description": "Successfully retrieved dashboard details", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "properties": { "totalTestseries": { "type": "integer", "example": 10 }, "totalStudents": { "type": "integer", "example": 150 }, "totalInstructors": { "type": "integer", "example": 20 }, "topInstructors": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "John Doe" }, "rating": { "type": "number", "format": "float", "example": 4.5 }, "reviews": { "type": "integer", "example": 50 }, "total_students": { "type": "integer", "example": 100 }, "total_testseries": { "type": "integer", "example": 10 }, "description": { "type": "string", "example": "Top instructor" }, "image": { "type": "string", "example": "image.jpg" } }, "type": "object" } }, "topTestSeries": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Test Series 1" }, "testseries_image": { "type": "string", "example": "testseries_image.jpg" }, "tutor_name": { "type": "string", "example": "John Doe" }, "tutor_image": { "type": "string", "example": "tutor_image.jpg" } }, "type": "object" } }, "notifications": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "message": { "type": "string", "example": "Notification message" }, "image": { "type": "string", "example": "notification_image.jpg" }, "role_id": { "type": "integer", "example": 2 } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized (if the user is not authenticated)", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "User not authenticated" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/featured_test_series": { "get": { "tags": [ "user" ], "summary": "Retrieve featured test series", "description": "Fetches the top 6 featured test series that are approved and for sale, including associated user and teacher details.", "operationId": "4f04fabe19525607aeed83933e18ac3f", "responses": { "200": { "description": "Successfully retrieved featured test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "images_path": { "type": "string", "example": "upload/testseries/" }, "total_test_series": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Test Series A" }, "price": { "type": "number", "format": "float", "example": 99.99 }, "total_time": { "type": "string", "example": "2 hours" }, "testseries_image": { "type": "string", "example": "https://example.com/images/testseries_round_image.png" } }, "type": "object" } }, "trending_test_series": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Trending Test Series" }, "price": { "type": "number", "format": "float", "example": 59.99 }, "total_time": { "type": "string", "example": "1.5 hours" }, "testseries_image": { "type": "string", "example": "https://example.com/images/trending_testseries_image.png" } }, "type": "object" } }, "popular_test_series": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Popular Test Series" }, "price": { "type": "number", "format": "float", "example": 79.99 }, "total_time": { "type": "string", "example": "2 hours" }, "testseries_image": { "type": "string", "example": "https://example.com/images/popular_testseries_image.png" } }, "type": "object" } }, "featured_test_series": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Featured Test Series" }, "price": { "type": "number", "format": "float", "example": 69.99 }, "total_time": { "type": "string", "example": "2 hours" }, "testseries_image": { "type": "string", "example": "https://example.com/images/featured_testseries_image.png" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "User not authenticated" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/test_series_detail/{id}": { "get": { "tags": [ "user" ], "summary": "Get details of a specific test series", "description": "Fetches details of a specific test series by its ID, including specific columns like id, user_id, name, testseries_image, instructions, short_description, price, description, total_time, and created_at. Also includes teacher details, total number of questions, and reviews.", "operationId": "86cc89e004720e0a271954e9df16a073", "parameters": [ { "name": "id", "in": "path", "description": "ID of the test series", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successfully retrieved test series details", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "teacher_image_path": { "type": "string", "example": "/upload/instructors/" }, "test_series_image_path": { "type": "string", "example": "upload/testseries/" }, "test_series_detail": { "properties": { "id": { "type": "integer", "example": 565 }, "user_id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Transportation in Animal and Plants" }, "testseries_image": { "type": "string", "example": "TS-1699861917.png" }, "instructions": { "type": "string", "example": "1. You must only attempt this exam once. ..." }, "short_description": { "type": "string", "example": "Test paper designed in a way that builds confidence..." }, "price": { "type": "string", "example": "10" }, "description": { "type": "string", "example": "Full description here." }, "total_time": { "type": "string", "example": "30" }, "created_at": { "type": "string", "format": "date-time", "example": "2023-11-13T13:10:56Z" } }, "type": "object" }, "teacher_detail": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "admin" }, "image": { "type": "string", "example": "IMG_20200616_191746879.jpg" } }, "type": "object" }, "total_test_series_question": { "type": "integer", "example": 12 }, "reviews": { "properties": { "skills": { "type": "string", "example": "Expert" }, "total_testseries": { "type": "integer", "example": 5 }, "rating": { "type": "number", "format": "float", "example": 4.5 }, "reviews": { "type": "string", "example": "Great test series!" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Test series not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Test series not found." } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/top_category": { "get": { "tags": [ "user" ], "summary": "Get top categories", "description": "Fetches top categories including details like category name, image, and slug.", "operationId": "3c257190d427a5e0eb132ab4db42f928", "responses": { "200": { "description": "Successfully retrieved categories", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "top_categories_image_path": { "type": "string", "example": "upload/categories/" }, "top_categories": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "category_name": { "type": "string", "example": "Science" }, "category_slug": { "type": "string", "example": "science" }, "category_image": { "type": "string", "example": "https://example.com/images/science.png" }, "category_desc": { "type": "string", "example": "Description of Science category." }, "category_sh_descr": { "type": "string", "example": "Short description." } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/all_category": { "get": { "tags": [ "user" ], "summary": "Get all categories", "description": "Fetches all categories including details like category name, image, and slug.", "operationId": "e23368109ff13744a0ea170500e62b10", "responses": { "200": { "description": "Successfully retrieved categories", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "categories_image_path": { "type": "string", "example": "upload/categories/" }, "categories": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "category_name": { "type": "string", "example": "Science" }, "category_slug": { "type": "string", "example": "science" }, "category_image": { "type": "string", "example": "https://example.com/images/science.png" }, "category_desc": { "type": "string", "example": "Description of Science category." }, "category_sh_descr": { "type": "string", "example": "Short description." } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/child_category/{parent_id}": { "get": { "tags": [ "user" ], "summary": "Get child categories for a given parent category", "description": "Fetches child categories for a specific parent category, including details like category name, image, and slug.", "operationId": "4babea0085ec299a1d71e41527589342", "parameters": [ { "name": "parent_id", "in": "path", "description": "ID of the parent category", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successfully retrieved child categories", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "categories_image_path": { "type": "string", "example": "upload/categories/" }, "categories": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "category_name": { "type": "string", "example": "Biology" }, "category_slug": { "type": "string", "example": "biology" }, "category_image": { "type": "string", "example": "https://example.com/images/biology.png" }, "category_desc": { "type": "string", "example": "Description of Biology category." }, "category_sh_descr": { "type": "string", "example": "Short description." } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/get_test_seriesByCategory/{categoryId}": { "get": { "tags": [ "user" ], "summary": "Get test series by category", "description": "Fetches test series for a specific category and its subcategories. Results are paginated.", "operationId": "fe5bf4f3f05d5e24d7b4d04cc73721ae", "parameters": [ { "name": "categoryId", "in": "path", "description": "ID of the category", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Successfully retrieved test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "test_series": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Test Series A" }, "description": { "type": "string", "example": "Full description here." }, "price": { "type": "integer", "example": 20 }, "total_time": { "type": "string", "example": "2 hours" }, "instructor": { "type": "string", "example": "John Doe" }, "tutor_image": { "type": "string", "example": "https://example.com/images/tutor_image.png" }, "rating": { "type": "integer", "example": 4 }, "total_students": { "type": "integer", "example": 200 }, "total_testseries": { "type": "integer", "example": 5 } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "http://localhost:8000/api/user/get_test_seriesByCategory/86?page=1" }, "last_page_url": { "type": "string", "example": "http://localhost:8000/api/user/get_test_seriesByCategory/86?page=5" }, "next_page_url": { "type": "string", "example": "http://localhost:8000/api/user/get_test_seriesByCategory/86?page=2" }, "prev_page_url": { "type": "string", "example": "null" }, "total": { "type": "integer", "example": 44 }, "per_page": { "type": "integer", "example": 10 } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/get_all_test_series": { "get": { "tags": [ "user" ], "summary": "Retrieve a paginated list of test series", "description": "Fetches a paginated list of test series with related teacher details. Returns an empty list with a 404 status if no test series are found.", "operationId": "909fb25ac27e99eebafdeb08938e06a9", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful response with a paginated list of test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "test_series": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Sample Test Series" }, "description": { "type": "string", "example": "Description of the test series" }, "for_sale": { "type": "boolean", "example": true }, "tseries_verif_status": { "type": "string", "example": "approved" }, "days": { "type": "integer", "example": 30 }, "created_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "teacherDetail": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Instructor Name" }, "image": { "type": "string", "example": "path/to/image.jpg" } }, "type": "object" } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "/api/test-series?page=1" }, "last_page_url": { "type": "string", "example": "/api/test-series?page=10" }, "next_page_url": { "type": "string", "example": "/api/test-series?page=2" }, "prev_page_url": { "type": "string", "example": "/api/test-series?page=1" }, "total": { "type": "integer", "example": 100 }, "per_page": { "type": "integer", "example": 5 } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "No test series found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "No test series found" }, "test_series": { "type": "array", "items": { "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/get_test_series_by_instructor": { "get": { "tags": [ "user" ], "summary": "Retrieve test series by instructor", "description": "Fetches a list of test series created by a specific instructor (user). Returns an empty list with a 404 status if no test series are found for the provided instructor.", "operationId": "defb2a595d6c07e4a014ed6f6b765d52", "parameters": [ { "name": "instructor_id", "in": "query", "description": "Instructor's user ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful response with a list of test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "test_series": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Sample Test Series" }, "description": { "type": "string", "example": "Description of the test series" }, "for_sale": { "type": "boolean", "example": true }, "tseries_verif_status": { "type": "string", "example": "approved" }, "days": { "type": "integer", "example": 30 }, "created_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "teacherDetail": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Instructor Name" }, "image": { "type": "string", "example": "path/to/image.jpg" } }, "type": "object" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "No test series found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "No test series found" }, "test_series": { "type": "array", "items": { "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/search_test_series": { "get": { "tags": [ "user" ], "summary": "Search for test series", "description": "Searches for test series based on the given search terms in name . Returns an empty list with a 404 status if no matches are found.", "operationId": "f5aeb9767695b1b25671407c4bb2c7c7", "parameters": [ { "name": "search", "in": "query", "description": "Search term for the test series name", "required": true, "schema": { "type": "string", "example": "magnetic-field" } } ], "responses": { "200": { "description": "Successful response with the list of matching test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "test_series": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Sample Test Series" }, "description": { "type": "string", "example": "Description of the test series" }, "for_sale": { "type": "boolean", "example": true }, "tseries_verif_status": { "type": "string", "example": "approved" }, "days": { "type": "integer", "example": 30 }, "created_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "teacherDetail": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Instructor Name" }, "image": { "type": "string", "example": "path/to/image.jpg" } }, "type": "object" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "No matching test series found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "No matching test series found" }, "test_series": { "type": "array", "items": { "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/purchase_test_series": { "post": { "tags": [ "user" ], "summary": "Purchase Test Series", "description": "Allows a user to purchase a test series either through wallet balance or Razorpay payment gateway.", "operationId": "f8c91c9505a32e4558b6e17bf775b1a9", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "test_series_id", "price" ], "properties": { "test_series_id": { "description": "ID of the test series to be purchased", "type": "integer", "example": 1 }, "price": { "description": "Price of the test series", "type": "number", "format": "float", "example": 499.99 } }, "type": "object" } } } }, "responses": { "200": { "description": "Test Series Purchased Successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Test Series Purchased Successfully" }, "payment_status": { "type": "string", "example": "success" } }, "type": "object" } }, "type": "object" } } } }, "403": { "description": "Unauthorized or Profile Deactivated", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Your Profile is Deactivated." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Exception details" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/razorpay-success": { "post": { "tags": [ "user" ], "summary": "Handle Success Response from Razorpay", "description": "Processes the successful payment response from Razorpay and enrolls the user in the test series.", "operationId": "a3116fbcb3d895166f36b32c6abad6e9", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "payment_id", "razorpay_payment_id" ], "properties": { "payment_id": { "description": "ID of the payment record in the system", "type": "integer", "example": 1 }, "razorpay_payment_id": { "description": "Payment ID provided by Razorpay", "type": "string", "example": "rzp_test_abc123" } }, "type": "object" } } } }, "responses": { "200": { "description": "Payment successful and user enrolled in test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Payment successful and user enrolled in test series" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Payment verification failed" }, "error": { "type": "string", "example": "Exception details" } }, "type": "object" } }, "type": "object" } } } } } } }, "/api/user/razorpay-failed": { "post": { "tags": [ "user" ], "summary": "Handle Failed Response from Razorpay", "description": "Processes the failed payment response from Razorpay and updates the payment status in the system.", "operationId": "0cae94d7cc0d33e2b38768b8d06afbe6", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "payment_id", "razorpay_payment_id" ], "properties": { "payment_id": { "description": "ID of the payment record in the system", "type": "integer", "example": 1 }, "razorpay_payment_id": { "description": "Payment ID provided by Razorpay", "type": "string", "example": "rzp_test_abc123" } }, "type": "object" } } } }, "responses": { "200": { "description": "Payment failed response handled successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Payment failed. Please try again." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Payment verification failed" }, "error": { "type": "string", "example": "Exception details" } }, "type": "object" } }, "type": "object" } } } } } } }, "/api/user/scholarship_apply": { "post": { "tags": [ "user" ], "summary": "Apply for a scholarship", "description": "Allows a user to apply for a scholarship with their details.", "operationId": "9cbb2163dbd1974ce4d754734310f344", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "applicant_name", "father_name", "mother_name", "mobile_no", "dob", "gender", "address", "adahar_no", "state", "district", "pincode", "school", "class" ], "properties": { "applicant_name": { "type": "string", "example": "John Doe" }, "father_name": { "type": "string", "example": "Richard Doe" }, "mother_name": { "type": "string", "example": "Jane Doe" }, "mobile_no": { "type": "integer", "example": "1234567890" }, "dob": { "type": "string", "format": "date", "example": "2000-01-01" }, "physically_challenged": { "type": "integer", "enum": [ 0, 1 ], "example": 0 }, "cast_category": { "type": "integer", "example": "2" }, "gender": { "type": "string", "example": "Male" }, "address": { "type": "string", "example": "123 Main Street" }, "adahar_no": { "type": "integer", "example": "123456789012" }, "state": { "type": "integer", "example": "11" }, "district": { "type": "string", "example": "Los Angeles" }, "pincode": { "type": "integer", "example": "90001" }, "school": { "type": "integer", "example": "2" }, "class": { "type": "integer", "example": "10" } }, "type": "object" } } } }, "responses": { "200": { "description": "Scholarship application successfully created", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Scholarship Application added successfully" }, "scholarship": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "applicant_name": { "type": "string", "example": "John Doe" }, "father_name": { "type": "string", "example": "Richard Doe" }, "mother_name": { "type": "string", "example": "Jane Doe" }, "mobile_no": { "type": "integer", "example": "1234567890" }, "dob": { "type": "string", "format": "date", "example": "2000-01-01" }, "physically_challenged": { "type": "integer", "example": 0 }, "cast_category": { "type": "integer", "example": "2" }, "gender": { "type": "string", "example": "Male" }, "address": { "type": "string", "example": "123 Main Street" }, "adahar_no": { "type": "integer", "example": "123456789012" }, "state": { "type": "integer", "example": "11" }, "district": { "type": "string", "example": "Los Angeles" }, "pincode": { "type": "integer", "example": "90001" }, "school": { "type": "integer", "example": "2" }, "class": { "type": "integer", "example": "10" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Validation error message" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/all_scholarships": { "get": { "tags": [ "user" ], "summary": "Retrieve all scholarship applications", "description": "Fetches all scholarship applications from the database.", "operationId": "b3c2709f06d08a52adaba1dbc75cbb1a", "responses": { "200": { "description": "Scholarship applications retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Scholarship applications retrieved successfully" }, "scholarships": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "applicant_name": { "type": "string", "example": "John Doe" }, "father_name": { "type": "string", "example": "Richard Doe" }, "mother_name": { "type": "string", "example": "Jane Doe" }, "mobile_no": { "type": "string", "example": "1234567890" }, "dob": { "type": "string", "format": "date", "example": "2000-01-01" }, "physically_challenged": { "type": "boolean", "example": false }, "cast_category": { "type": "string", "example": "General" }, "gender": { "type": "string", "example": "Male" }, "address": { "type": "string", "example": "123 Main Street" }, "adahar_no": { "type": "string", "example": "1234-5678-9012" }, "state": { "type": "string", "example": "California" }, "district": { "type": "string", "example": "Los Angeles" }, "pincode": { "type": "string", "example": "90001" }, "school": { "type": "string", "example": "Central High School" }, "class": { "type": "string", "example": "10th" }, "applicat_photo": { "type": "string", "example": "/storage/upload/profile/photo.jpg" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-08-22T00:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-08-22T00:00:00Z" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/single_scholarship/{id}": { "get": { "tags": [ "user" ], "summary": "Retrieve a single scholarship application for editing", "description": "Fetches a single scholarship application record by ID for the authenticated user.", "operationId": "51cf1229575008bffe3fd73727ee8988", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the scholarship application to retrieve", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Scholarship application retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Scholarship application retrieved successfully" }, "scholarship": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "applicant_name": { "type": "string", "example": "John Doe" }, "father_name": { "type": "string", "example": "Richard Doe" }, "mother_name": { "type": "string", "example": "Jane Doe" }, "mobile_no": { "type": "string", "example": "1234567890" }, "dob": { "type": "string", "format": "date", "example": "2000-01-01" }, "physically_challenged": { "type": "boolean", "example": false }, "cast_category": { "type": "string", "example": "General" }, "gender": { "type": "string", "example": "Male" }, "address": { "type": "string", "example": "123 Main Street" }, "adahar_no": { "type": "string", "example": "1234-5678-9012" }, "state": { "type": "string", "example": "California" }, "district": { "type": "string", "example": "Los Angeles" }, "pincode": { "type": "string", "example": "90001" }, "school": { "type": "string", "example": "Central High School" }, "class": { "type": "string", "example": "10th" }, "applicat_photo": { "type": "string", "example": "/storage/upload/profile/photo.jpg" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-08-22T00:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-08-22T00:00:00Z" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "The selected id is invalid." } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Scholarship application not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Scholarship application not found" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/available-scholarship/testseries": { "get": { "tags": [ "user" ], "summary": "Retrieve a list of test series for a user's scholarship group", "description": "Fetches a list of test series associated with the user's scholarship group. If no test series are found, returns an empty list with a 404 status.", "operationId": "12617d6d6d086b431f7ce8e1efac7e83", "responses": { "200": { "description": "Successful response with a list of test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Scholarship Group test series retrieved successfully" }, "teacher_image_path": { "type": "string", "example": "/upload/instructors/" }, "test_series_image_path": { "type": "string", "example": "upload/testseries/" }, "test_series": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1313 }, "user_id": { "type": "integer", "example": 555 }, "name": { "type": "string", "example": "Rational number PFT" }, "testseries_image": { "type": "string", "example": null }, "category_id": { "type": "string", "example": "1450" }, "testseries_slug": { "type": "string", "example": "rational-number-pft" }, "instructions": { "type": "string", "example": "." }, "total_time": { "type": "string", "example": "30" }, "price": { "type": "string", "example": "10" }, "is_enrolled": { "type": "boolean", "example": false }, "teacherDetail": { "properties": { "id": { "type": "integer", "example": 555 }, "name": { "type": "string", "example": "Supriya Dixit" }, "image": { "type": "string", "example": "" } }, "type": "object" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "No test series found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "No test series found" }, "test_series": { "type": "array", "items": { "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/update_scholarship": { "post": { "tags": [ "user" ], "summary": "Update a scholarship application", "description": "Allows a user to update their scholarship application details.", "operationId": "c46dd197618ba3ab3f305c87e322c919", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "update_id", "applicant_name", "father_name", "mother_name", "mobile_no", "dob", "gender", "address", "adahar_no", "state", "district", "pincode", "school", "class" ], "properties": { "update_id": { "description": "Scholarship ID", "type": "integer", "example": 1 }, "applicant_name": { "type": "string", "example": "John Doe" }, "father_name": { "type": "string", "example": "Richard Doe" }, "mother_name": { "type": "string", "example": "Jane Doe" }, "mobile_no": { "type": "string", "example": "1234567890" }, "dob": { "type": "string", "format": "date", "example": "2000-01-01" }, "physically_challenged": { "type": "integer", "enum": [ 0, 1 ], "example": 0 }, "cast_category": { "type": "integer", "example": 2 }, "gender": { "type": "string", "example": "Male" }, "address": { "type": "string", "example": "123 Main Street" }, "adahar_no": { "type": "string", "example": "123456789012" }, "state": { "type": "integer", "example": 11 }, "district": { "type": "string", "example": "Los Angeles" }, "pincode": { "type": "string", "example": "90001" }, "school": { "type": "integer", "example": 2 }, "class": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "responses": { "200": { "description": "Scholarship application updated successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Scholarship Application updated successfully" }, "scholarship": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "applicant_name": { "type": "string", "example": "John Doe" }, "father_name": { "type": "string", "example": "Richard Doe" }, "mother_name": { "type": "string", "example": "Jane Doe" }, "mobile_no": { "type": "string", "example": "1234567890" }, "dob": { "type": "string", "format": "date", "example": "2000-01-01" }, "physically_challenged": { "type": "integer", "example": 0 }, "cast_category": { "type": "integer", "example": 2 }, "gender": { "type": "string", "example": "Male" }, "address": { "type": "string", "example": "123 Main Street" }, "adahar_no": { "type": "string", "example": "123456789012" }, "state": { "type": "integer", "example": 11 }, "district": { "type": "string", "example": "Los Angeles" }, "pincode": { "type": "string", "example": "90001" }, "school": { "type": "integer", "example": 2 }, "class": { "type": "integer", "example": 10 }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Validation error message" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/schools": { "get": { "tags": [ "user" ], "summary": "Get all active schools", "description": "Fetches a list of all active schools with their IDs and names. If no logo is available, a default image is provided.", "operationId": "20e0b9c0016a27235d295222472e0b66", "responses": { "200": { "description": "List of active schools with ID and name", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "school_name": { "type": "string", "example": "Greenwood High" } }, "type": "object" } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/schools-group": { "get": { "tags": [ "user" ], "summary": "Get all active schools with scholarship groups", "description": "Fetches a list of all active schools that provide scholarships, including groups associated with each school.", "operationId": "350027073cdbedef4ad74aa4d4bb3044", "responses": { "200": { "description": "List of active schools with scholarship groups", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "schools": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "school_name": { "type": "string", "example": "Greenwood High" }, "is_provide_scholarship": { "type": "boolean", "example": true }, "groups": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 101 }, "name": { "type": "string", "example": "Science Scholarship Group" }, "school_id": { "type": "integer", "example": 1 }, "status": { "type": "boolean", "example": true }, "created_at": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-01-10T12:00:00Z" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/all_states": { "get": { "tags": [ "user" ], "summary": "Get all states", "description": "Fetches a list of all states with their IDs and names.", "operationId": "4fbb4c50b9f2a956031acabe765356f6", "responses": { "200": { "description": "List of states with ID and name", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "state_name": { "type": "string", "example": "California" } }, "type": "object" } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/all_districts": { "get": { "tags": [ "user" ], "summary": "Get districts by state", "description": "Fetches a list of districts for a given state ID.", "operationId": "b06b3a9fc4a483a67d525df6bcb7b298", "parameters": [ { "name": "fk_state_id", "in": "query", "description": "The ID of the state to filter districts by", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of districts with ID and name for the given state ID", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "city_name": { "type": "string", "example": "Los Angeles" } }, "type": "object" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "The fk_state_id field is required." } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "No districts found for the given state ID" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/wallet_history": { "get": { "tags": [ "user" ], "summary": "Retrieve wallet history for the authenticated user", "description": "Fetches the wallet transaction history for the currently authenticated user.", "operationId": "3b44dcbc18538511879c14acb38e4248", "responses": { "200": { "description": "Wallet history successfully retrieved", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "wallet_history": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "amount": { "type": "number", "format": "float", "example": 100.5 }, "transaction_type": { "type": "string", "example": "credit" }, "description": { "type": "string", "example": "Salary credited" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-08-22T00:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-08-22T00:00:00Z" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An unexpected error occurred" }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/wallet_add": { "post": { "tags": [ "user" ], "summary": "Add amount to wallet", "description": "This endpoint allows authenticated users to add an amount to their wallet. It creates a Razorpay order and returns the necessary details for the transaction.", "operationId": "f0118467b8774e91028a1c0577c17aca", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "amount" ], "properties": { "amount": { "description": "The amount to be added to the wallet in INR. Minimum amount should be Rs. 200.", "type": "integer", "format": "int64", "example": 1000 } }, "type": "object" } } } }, "responses": { "200": { "description": "Order Created Successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Order Created Successfully" }, "data": { "properties": { "redirect_url": { "type": "string", "example": "https://example.com/add-wallet-payment/order_DB2P2z34d" }, "order_id": { "type": "integer", "example": 1 }, "amount": { "type": "integer", "example": 100000 }, "currency": { "type": "string", "example": "INR" }, "razorpay_key": { "type": "string", "example": "rzp_test_1234567890" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Minimum Amount added should be Rs. 200", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Minimum Amount added should be Rs. 200" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred: [error message]" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/wallet_verify": { "post": { "tags": [ "user" ], "summary": "Verify payment", "description": "This endpoint verifies the payment made via Razorpay and adds the amount to the user's wallet.", "operationId": "43ca9f7637faf82635fe6abecc6b6114", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "rzp_orderid", "rzp_paymentid" ], "properties": { "rzp_orderid": { "description": "Razorpay order ID", "type": "string", "example": "order_DB2P2z34d" }, "rzp_paymentid": { "description": "Razorpay payment ID", "type": "string", "example": "pay_Abc123" } }, "type": "object" } } } }, "responses": { "200": { "description": "Payment successful, amount added to wallet", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Payment successful, amount added to wallet" }, "data": { "properties": { "wallet_balance": { "type": "integer", "example": 1500 }, "wallet_history": { "properties": { "message": { "type": "string", "example": "No wallet history found" }, "data": { "type": "array", "items": { "properties": { "date": { "type": "string", "format": "date", "example": "2024-08-23" }, "amount": { "type": "integer", "example": 500 }, "remarks": { "type": "string", "example": "Added in wallet" }, "type": { "type": "string", "example": "credit" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid Order Id & RAZORPAY Order Id", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid Order Id & RAZORPAY Order Id" } }, "type": "object" } } } }, "500": { "description": "Payment Failed, Please Try Again", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Payment Failed, Please Try Again" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/instructor_detail": { "get": { "tags": [ "user" ], "summary": "Retrieve instructor details", "description": "Fetches the details of a single instructor by their ID.", "operationId": "d6eb1458e2d89c8e2a738e8b83133d40", "parameters": [ { "name": "id", "in": "query", "description": "ID of the instructor", "required": true, "schema": { "type": "string", "example": "485" } } ], "responses": { "200": { "description": "Successfully retrieved instructor details", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "instructor_image_path": { "type": "string", "example": "/upload/instructors/" }, "instructor": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "John Doe" }, "image": { "type": "string", "example": "john_doe.png" }, "experience": { "type": "string", "example": "5 years" }, "qualification": { "type": "string", "example": "M.Sc. in Physics" }, "teacher_details": { "properties": { "additional_info": { "type": "string", "example": "Expert in Quantum Physics" } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Instructor not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Instructor not found" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/all_instructors": { "get": { "tags": [ "user" ], "summary": "Retrieve all instructors", "description": "Fetches the all instructors who are active and have the role_id of 3.", "operationId": "507c7bffb25444ff86f8f6b8dce5cd63", "responses": { "200": { "description": "Successfully retrieved all instructors", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "allInstructors_image_path": { "type": "string", "example": "/upload/instructors/" }, "allInstructors": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "John Doe" }, "image": { "type": "string", "example": "john_doe.png" }, "experience": { "type": "string", "example": "5 years" }, "qualification": { "type": "string", "example": "M.Sc. in Physics" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series": { "get": { "tags": [ "user" ], "summary": "Retrieve all enrollments for the authenticated user", "description": "Fetches all enrollments from the enroll_testseries table for the authenticated user.", "operationId": "cac024ee4b39952e6bed1c5acf191532", "responses": { "200": { "description": "Successfully retrieved all enrollments test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "enrollments": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "enroll_type": { "type": "string", "example": "monthly" }, "testseries_id": { "type": "integer", "example": 2 }, "plan_id": { "type": "integer", "example": 1 }, "pay_id": { "type": "integer", "example": 3 }, "start_date": { "type": "string", "format": "date", "example": "2024-09-01" }, "end_date": { "type": "string", "format": "date", "example": "2024-09-30" }, "days": { "type": "integer", "example": 30 }, "enroll_by": { "type": "string", "example": "admin" }, "enroll_status": { "type": "string", "example": "active" }, "test_start_time": { "type": "string", "format": "date-time", "example": "2024-09-05T10:00:00" }, "test_progress_time": { "type": "string", "format": "date-time", "example": null }, "test_end_time": { "type": "string", "format": "date-time", "example": "2024-09-05T12:00:00" }, "test_submit_time": { "type": "string", "format": "date-time", "example": null }, "created_at": { "type": "string", "format": "date-time", "example": "2024-09-01T12:00:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-09-01T12:00:00" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/bundle-testseries/{enrollment_id}": { "get": { "tags": [ "user" ], "summary": "Get Bundle Test Series", "description": "Fetches the bundle test series associated with the authenticated user based on the enrollment ID.", "operationId": "27a2b1541de3e6ed6e961fa2e39c7ec4", "parameters": [ { "name": "enrollment_id", "in": "path", "description": "Enrollment ID of the user", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successfully retrieved the enrolled test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "My enrolled Test series retrieved successfully" }, "test_series_image_path": { "type": "string", "example": "upload/testseries/" }, "instructor_image_path": { "type": "string", "example": "upload/instructors/" }, "my_test_series": { "type": "array", "items": { "properties": { "enrollment_id": { "type": "integer", "example": 1 }, "id": { "type": "integer", "example": 101 }, "name": { "type": "string", "example": "Sample Test Series" }, "image": { "type": "string", "example": "sample.jpg" }, "instructor": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Instructor Name" }, "image": { "type": "string", "example": "instructor.jpg" } }, "type": "object" }, "questions_count": { "type": "integer", "example": 50 }, "total_time": { "type": "integer", "example": 120 }, "category_id": { "type": "integer", "example": 1 }, "testseries_slug": { "type": "string", "example": "sample-test-series" }, "instructions": { "type": "string", "example": "Follow the instructions carefully" }, "short_description": { "type": "string", "example": "A sample test series" }, "negative_marks": { "type": "integer", "example": 1 }, "per_ques_mark": { "type": "integer", "example": 5 }, "max_questions": { "type": "integer", "example": 100 }, "attempt_per_stud": { "type": "integer", "example": 3 }, "tseries_verif_status": { "type": "integer", "example": 1 }, "price": { "type": "number", "format": "float", "example": 49.99 }, "days": { "type": "integer", "example": 30 }, "type": { "type": "string", "example": "Full Test Series" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-11-13T12:00:00Z" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Test series or enrollment not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Enrolled test series not found" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/bundle-testseries-questions/{enrollment_id}/{testseries_id}": { "get": { "tags": [ "user" ], "summary": "Get questions for a bundle test series", "description": "Retrieve questions and their details for a specific test series in a bundle.", "operationId": "getBundleTestSeriesQuestions", "parameters": [ { "name": "enrollment_id", "in": "path", "description": "The ID of the test series enrollment", "required": true, "schema": { "type": "integer" } }, { "name": "testseries_id", "in": "path", "description": "The ID of the test series", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful retrieval of test series questions", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Questions retrieved successfully" }, "total_section": { "type": "integer", "example": 1 }, "totalQuestions": { "type": "integer", "example": 40 }, "totalTime": { "type": "string", "example": "60" }, "per_question_mark": { "type": "integer", "example": 4 }, "totalMarks": { "type": "integer", "example": 160 }, "sections": { "type": "array", "items": { "properties": { "section_id": { "type": "integer", "example": 48 }, "section_title": { "type": "string", "example": "PSB Class 6 Scholarship Test" }, "enrollment_id": { "type": "integer", "example": 7 }, "bundle_id": { "type": "integer", "example": 57 }, "bundle_testseries_name": { "type": "string", "example": "BPS School Package" }, "section_total_question": { "type": "integer", "example": 40 }, "type": { "type": "string", "example": "testseries" }, "questions": { "type": "array", "items": { "properties": { "testseries_question_id": { "type": "integer", "example": 906 }, "testseries_id": { "type": "integer", "example": 48 }, "testseries_priority": { "type": "string", "example": "high" }, "question_id": { "type": "integer", "example": 42151 }, "question_text": { "type": "string", "example": "

The words Satyameva Jayate in the State Emblem of India have been adopted from which one of the following?

" }, "question_marks": { "type": "integer", "example": 1 }, "answer_type": { "type": "string", "example": "radio" }, "is_integertype": { "type": "boolean", "example": false }, "question_status": { "type": "integer", "example": 0 }, "enable_clear": { "type": "boolean", "example": false }, "start_time": { "type": "string", "example": "" }, "end_time": { "type": "string", "example": "" }, "options": { "type": "array", "items": { "properties": { "option_id": { "type": "integer", "example": 101948 }, "is_selected": { "type": "boolean", "example": false }, "option_text": { "type": "string", "example": "

Maitreyi Upanishad

" } }, "type": "object" } }, "user_answer": { "type": "string", "example": null, "nullable": true }, "question_mark": { "type": "integer", "example": 1 }, "ques_seq": { "type": "integer", "example": 0 } }, "type": "object" } } }, "type": "object" } }, "developer_information_msg": { "type": "string", "example": "Developer Information: 'radio' = Single-choice, 'checkbox' = Multiple-choice." } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Test series or enrollment not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Test series not found" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Exception message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/test_series_heading": { "get": { "tags": [ "user" ], "summary": "Get test series headings for the authenticated user", "description": "Returns a list of test series headings including static and user-associated groups.", "operationId": "getTestSeriesHeading", "responses": { "200": { "description": "Test series heading retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Test series heading retrieved successfully" }, "my_test_series_heading": { "type": "array", "items": { "properties": { "id": { "type": "string", "example": "0001" }, "name": { "type": "string", "example": "Bundle" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred while processing your request", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_by_type/{group_id}": { "get": { "tags": [ "user" ], "summary": "Fetch My Test Series by Type", "description": "Retrieves the user's enrolled test series based on the specified type from their associated groups.", "operationId": "MyTest_Series_ByType", "parameters": [ { "name": "group_id", "in": "path", "description": "The ID of the group to fetch the test series for.", "required": true, "schema": { "type": "string", "example": "0001" } } ], "responses": { "200": { "description": "Successfully retrieved test series", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "properties": { "enrollment_id": { "type": "integer" }, "user_id": { "type": "integer" }, "enroll_type": { "type": "string", "example": "testseries" }, "testseries_id": { "type": "integer" }, "plan_id": { "type": "integer", "nullable": true }, "pay_id": { "type": "integer", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "example": "2024-10-17T06:27:38.000000Z" }, "end_date": { "type": "string", "format": "date-time", "example": "2024-11-16T06:27:38.000000Z" }, "enrollment_days": { "type": "integer", "example": 30 }, "enroll_by": { "type": "integer" }, "enroll_status": { "type": "string", "example": "1" }, "test_start_time": { "type": "string", "format": "date-time", "nullable": true }, "test_progress_time": { "type": "string", "format": "date-time", "nullable": true }, "test_end_time": { "type": "string", "format": "date-time", "nullable": true }, "test_submit_time": { "type": "string", "format": "date-time", "nullable": true }, "enrollment_created_at": { "type": "string", "format": "date-time", "example": "2024-10-17 06:27:38" }, "test_series": { "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "name": { "type": "string", "example": "Social Science Section (class -10) Test-3" }, "testseries_image": { "type": "string", "example": "" }, "category_id": { "type": "string", "example": "79,347" }, "testseries_slug": { "type": "string", "example": "social-science-section-(class--10)-test-3" }, "instructions": { "type": "string", "example": "na" }, "short_description": { "type": "string", "example": "na" }, "total_time": { "type": "string", "example": "10" }, "negative_marks": { "type": "string", "example": "1" }, "per_ques_mark": { "type": "integer", "example": 4 }, "max_questions": { "type": "integer", "nullable": true }, "attempt_per_stud": { "type": "string", "example": "2" }, "tseries_verif_status": { "type": "string", "example": "approved" }, "price": { "type": "string", "example": "5" }, "days": { "type": "integer", "example": 30 }, "type": { "type": "string", "example": "section" }, "created_at": { "type": "string", "format": "date-time", "example": "2023-11-11T15:36:43.000000Z" }, "instructor_detail": { "properties": { "id": { "type": "integer" }, "name": { "type": "string", "example": "admin" }, "image": { "type": "string", "example": "IMG_20200616_191746879.jpg" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access. Please log in." } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "No associated groups found or invalid group ID", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "No associated groups found for this user." } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid group ID provided", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Invalid group ID provided." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred while processing the request", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_detail/{enrollment_id}/{testseries_id}": { "get": { "tags": [ "user" ], "summary": "Retrieve details of a single or all test series enrollment for the authenticated user", "description": "Fetches details of a specific test series enrollment or all test series if testseries_id is 0.", "operationId": "42fb520496c3e4c635eb2797697a8537", "parameters": [ { "name": "enrollment_id", "in": "path", "description": "ID of the enrollment to retrieve", "required": true, "schema": { "type": "integer" } }, { "name": "testseries_id", "in": "path", "description": "ID of the test series to retrieve. Use 0 to retrieve all test series under this enrollment.", "required": true, "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "Successfully retrieved test series enrollment detail", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Enrollment or Test Series not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Enrollment or Test Series not found" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_questions/{enrollment_id}": { "get": { "tags": [ "user" ], "summary": "Retrieve test series questions for the authenticated user", "description": "Fetches all questions from the enrolled test series for the authenticated user along with their respective options 0 = unattempted, 1 = skip, 2 = pending, 3 = clear, 4 = save.", "operationId": "b67a88bb740bf106e3fe3b6e78fb953c", "parameters": [ { "name": "enrollment_id", "in": "path", "description": "ID of the enrollment for which to fetch questions", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successfully retrieved the test series questions", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Questions retrieved successfully" }, "developer_information_msg": { "type": "string", "example": "Developer Information: - 'radio' represents a Single-choice question (Single Answer). - 'checkbox' represents a Multiple-choice question (Multiple Answers). - 'textarea' represents a Subjective question (Free Text Answer)." }, "total_questions": { "type": "integer", "example": 10 }, "total_time": { "type": "integer", "example": 120 }, "total_marks": { "type": "integer", "example": 100 }, "test_series_questions": { "type": "array", "items": { "properties": { "testseries_question_id": { "type": "integer", "example": 1 }, "question_id": { "type": "integer", "example": 101 }, "question_text": { "type": "string", "example": "What is the capital of France?" }, "answer_type": { "type": "string", "example": "radio" }, "is_integertype": { "type": "boolean", "example": true }, "question_status": { "type": "integer", "example": 1 }, "is_selected": { "type": "boolean", "example": true }, "options": { "type": "array", "items": { "properties": { "option_id": { "type": "integer", "example": 1 }, "option_text": { "type": "string", "example": "Paris" } }, "type": "object" } }, "question_mark": { "type": "integer", "example": 5 }, "ques_seq": { "type": "integer", "example": 1 } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Test series enrollment not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Test series Enrollment not found" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_questions/v2/{enrollment_id}": { "get": { "tags": [ "user" ], "summary": "Retrieve test series questions by enrollment ID", "description": "This endpoint retrieves the test series questions for a specific enrollment based on the user's authentication token and enrollment ID.", "operationId": "7bb5dd79752f65f662043116697a7fe4", "parameters": [ { "name": "enrollment_id", "in": "path", "description": "The ID of the test series enrollment", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Questions retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Questions retrieved successfully" }, "developer_information_msg": { "type": "string", "example": "Developer Information: 'radio' represents ..." }, "total_questions": { "type": "integer", "example": 50 }, "total_time": { "type": "string", "example": "30" }, "total_marks": { "type": "integer", "example": 50 }, "test_series_questions": { "type": "array", "items": { "type": "array", "items": { "properties": { "section_title": { "type": "string", "example": "Section 1" }, "testseries_question_id": { "type": "integer", "example": 1 }, "question_id": { "type": "integer", "example": 101 }, "question_text": { "type": "string", "example": "What is the capital of France?" }, "answer_type": { "type": "string", "example": "radio" }, "is_integertype": { "type": "boolean", "example": false }, "options": { "type": "array", "items": { "properties": { "option_id": { "type": "integer", "example": 1 }, "is_selected": { "type": "boolean", "example": false }, "option_text": { "type": "string", "example": "Paris" } }, "type": "object" } }, "question_mark": { "type": "integer", "example": 1 } }, "type": "object" } } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Test series Enrollment not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Test series Enrollment not found" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Error message details" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_submit_single_question": { "post": { "tags": [ "user" ], "summary": "Submit a single question for a test series", "description": "Submit the status and answer (if applicable) for a specific question in a test series. The endpoint handles various question statuses: Skipped, Pending, Cleared, and Submitted.", "operationId": "TestSeriesSingleQuestionSubmit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "test_series_questions" ], "properties": { "test_series_questions": { "type": "array", "items": { "properties": { "testseries_id": { "description": "ID of the test series", "type": "integer", "example": 1 }, "question_id": { "description": "ID of the question", "type": "integer", "example": 1 }, "question_status": { "description": "Status of the question: 1=Skipped, 2=Pending, 3=Cleared, 4=Submitted", "type": "integer", "enum": [ 1, 2, 3, 4 ], "example": 4 }, "start_time": { "description": "Start time of answering the question", "type": "string", "format": "date-time", "example": "2023-09-27T07:40:25Z" }, "end_time": { "description": "End time of answering the question", "type": "string", "format": "date-time", "example": "2023-09-27T07:45:25Z" }, "is_integertype": { "description": "Indicates if the question requires integer only input", "type": "boolean", "example": false }, "answer_type": { "description": "Type of answer expected (e.g., multiple_choice, true_false)", "type": "string", "example": "multiple_choice" }, "options": { "type": "array", "items": { "properties": { "option_id": { "description": "ID of the option", "type": "integer", "example": 1 }, "is_selected": { "description": "Indicates if this option is selected", "type": "boolean", "example": true } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful submission of the question.", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Indicates request success", "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Question submitted successfully" }, "user_id": { "type": "integer", "example": 1 }, "testseries_id": { "type": "integer", "example": 1 }, "question_id": { "type": "integer", "example": 1 }, "answer_id": { "description": "ID of the selected answer option", "type": "integer", "example": 1 }, "total_time_spent": { "description": "Total time spent on the question", "type": "integer", "example": 30 } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing the request" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_submit_single_question_v2": { "post": { "tags": [ "user" ], "summary": "Submit a single question for a test series", "description": "Submit the status and answer (if applicable) for a specific question in a test series.", "operationId": "SubmitSingleQuestionTestSeries", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "test_series_questions" ], "properties": { "test_series_questions": { "type": "array", "items": { "properties": { "testseries_id": { "description": "ID of the test series", "type": "integer", "example": 1 }, "question_id": { "description": "ID of the question", "type": "integer", "example": 1 }, "question_status": { "description": "Status of the question: 1=Skipped, 2=Pending, 3=Cleared, 4=Submitted", "type": "integer", "enum": [ 1, 2, 3, 4 ], "example": 4 }, "start_time": { "description": "Start time of answering the question", "type": "string", "format": "date-time", "example": "2023-09-27T07:40:25Z" }, "end_time": { "description": "End time of answering the question", "type": "string", "format": "date-time", "example": "2023-09-27T07:45:25Z" }, "is_integertype": { "description": "Indicates if the question requires integer only input", "type": "boolean", "example": false }, "answer_type": { "description": "Type of answer expected (e.g., multiple_choice, true_false)", "type": "string", "example": "multiple_choice" }, "options": { "type": "array", "items": { "properties": { "option_id": { "description": "ID of the option", "type": "integer", "example": 1 }, "is_selected": { "description": "Indicates if this option is selected", "type": "boolean", "example": true } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful submission of the question.", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Indicates request success", "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Question submitted successfully" }, "user_id": { "type": "integer", "example": 1 }, "testseries_id": { "type": "integer", "example": 1 }, "question_id": { "type": "integer", "example": 1 }, "answer_id": { "description": "ID of the selected answer option", "type": "integer", "example": 1 }, "total_time_spent": { "description": "Total time spent on the question", "type": "integer", "example": 30 } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing the request" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_submit_all_question": { "post": { "tags": [ "user" ], "summary": "Submit all questions for a test series", "description": "This endpoint allows a user to submit the status and answer for specific questions in a test series. It handles various statuses: Skipped, Pending, Cleared, and Submitted.", "operationId": "TestSeriesSingleQuestionSubmitV1", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "test_series_questions" ], "properties": { "test_series_questions": { "type": "array", "items": { "properties": { "testseries_id": { "description": "ID of the test series", "type": "integer", "example": 1 }, "question_id": { "description": "ID of the question", "type": "integer", "example": 1 }, "question_status": { "description": "1=Skipped, 2=Pending, 3=Cleared, 4=Submitted", "type": "integer", "enum": [ 1, 2, 3, 4 ], "example": 4 }, "start_time": { "description": "Start time of answering the question", "type": "string", "format": "date-time", "example": "2023-09-27T07:40:25Z" }, "end_time": { "description": "End time of answering the question", "type": "string", "format": "date-time", "example": "2023-09-27T07:45:25Z" }, "options": { "type": "array", "items": { "properties": { "option_id": { "description": "ID of the option", "type": "integer", "example": 1 }, "is_selected": { "description": "Indicates if this option is selected", "type": "boolean", "example": true } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful submission of the exam.", "content": { "application/json": { "schema": { "properties": { "status": { "description": "True if submission is successful", "type": "boolean", "example": true }, "data": { "properties": { "message": { "description": "Success message", "type": "string", "example": "Exam submitted successfully." }, "responses": { "type": "array", "items": { "properties": { "question_id": { "description": "ID of the question", "type": "integer", "example": 1 }, "question_message": { "description": "Message regarding the question status", "type": "string", "example": "Question marked as submitted." }, "answer_id": { "description": "ID of the submitted answer, if applicable", "type": "integer", "example": 1 } }, "type": "object" } }, "testseries_result": { "properties": { "testseries_id": { "description": "ID of the test series", "type": "integer", "example": 1 }, "result_submited": { "description": "Indicates if the result was submitted", "type": "boolean", "example": true }, "updated_at": { "description": "Time when the result was updated", "type": "string", "format": "date-time", "example": "2023-09-27T07:50:25Z" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request, e.g., test series not found or already submitted.", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Indicates failure", "type": "boolean", "example": false }, "data": { "properties": { "message": { "description": "Error message", "type": "string", "example": "test series not found or already submitted" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred while processing the request.", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Indicates failure", "type": "boolean", "example": false }, "data": { "properties": { "message": { "description": "Error message", "type": "string", "example": "An error occurred while processing the request" }, "error": { "type": "string", "example": "Detailed error message if available" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_submit_exam": { "post": { "tags": [ "user" ], "summary": "Submit user's test series exam", "description": "This API submits the user's test series exam. The user must be authenticated via Sanctum. The request must include a valid test series ID, and the test result will be marked as submitted if not already submitted.", "operationId": "submitTestSeriesExam", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "testseries_id" ], "properties": { "testseries_id": { "description": "ID of the test series to be submitted", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Exam submitted successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Exam submitted successfully" }, "user_id": { "type": "integer", "example": 123 }, "testseries_id": { "type": "integer", "example": 1 }, "result_id": { "type": "integer", "example": 45 } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad Request - Validation failed or exam not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Exam test series not found or already submitted" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized - User not authenticated", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server Error - An error occurred while submitting the exam", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while submitting the exam. Please try again later." } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_history/{enrollment_id}/{testseries_id}": { "get": { "tags": [ "user" ], "summary": "Get Test Series History", "description": "Fetches the test series history for a specific enrollment and test series. \n * If the test series ID is not provided, it defaults to 0, returning all test series history for the enrollment.", "operationId": "8239709e8239f7bd5bc21636f2ecb01b", "parameters": [ { "name": "enrollment_id", "in": "path", "description": "ID of the enrollment", "required": true, "schema": { "type": "integer" } }, { "name": "testseries_id", "in": "path", "description": "ID of the test series (optional, defaults to 0 if not provided)", "required": false, "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "Test Series History retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Test Series History retrieved successfully" }, "test_series_name": { "type": "string", "example": "Mathematics Series" }, "show_result": { "type": "boolean", "example": true }, "test_series_history": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "enrollment_id": { "type": "integer", "example": 1001 }, "testseries_id": { "type": "integer", "example": 2001 }, "user_id": { "type": "integer", "example": 10 }, "result_submited": { "type": "boolean", "example": true }, "result_link": { "type": "string", "example": "https://example.com/user/result/1" } }, "type": "object" } }, "total_attempt_per_student": { "type": "string", "example": "5" }, "total_taken_attempts": { "type": "integer", "example": 3 }, "total_remaining_attempts": { "type": "integer", "example": 2 } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Test series not found or not enrolled", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Test series not found or not enrolled" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Exception message here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/my_test_series_history_v2/{enrollment_id}/{testseries_id}": { "get": { "tags": [ "user" ], "summary": "Fetch Test Series History", "description": "Retrieve the test series history for a specific user, including attempts, results, and remaining attempts.", "operationId": "TestSeriesHistoryV2", "parameters": [ { "name": "enrollment_id", "in": "path", "description": "The ID of the test series enrollment.", "required": true, "schema": { "type": "integer" } }, { "name": "testseries_id", "in": "path", "description": "The ID of the test series.", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Test Series History retrieved successfully.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Test Series History retrieved successfully" }, "test_series_name": { "type": "string", "example": "Math Test Series" }, "show_result": { "type": "boolean", "example": true }, "test_series_history": { "type": "array", "items": { "type": "object" } }, "total_attempt_per_student": { "type": "string", "example": "3" }, "total_taken_attempts": { "type": "integer", "example": 1 }, "total_remaining_attempts": { "type": "integer", "example": 2 } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Unauthorized access" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Enrollment or Test Series not found.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Test series not Enrollment" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred while processing your request.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Exception message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/order-history": { "get": { "tags": [ "user" ], "summary": "Get user order history", "description": "Retrieve the authenticated user's order history. Only successful orders of students are returned.", "operationId": "getOrderHistory", "responses": { "200": { "description": "Order history retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Order history retrieved successfully" }, "orders": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "order_id": { "type": "string", "example": "ORD123" }, "payment_id": { "type": "string", "example": "PAY456" }, "amount": { "type": "number", "format": "float", "example": 100.5 }, "status": { "type": "string", "example": "success" }, "testSeries": { "properties": { "id": { "type": "integer", "example": 10 }, "name": { "type": "string", "example": "Test Series 1" }, "testseries_image": { "type": "string", "example": "test_series_image_url" } }, "type": "object" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "No order history found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "No order history found" } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred while processing your request", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/contact_us": { "post": { "tags": [ "user" ], "summary": "Submit a contact form", "description": "Endpoint to submit a contact form message. Allows only one message per email address per day.", "operationId": "storeContactMessage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "email_id", "subject", "message" ], "properties": { "name": { "type": "string", "example": "John Doe" }, "email_id": { "type": "string", "example": "john.doe@example.com" }, "subject": { "type": "string", "example": "Inquiry about product" }, "message": { "type": "string", "example": "I would like more information about your product." } }, "type": "object" } } } }, "responses": { "201": { "description": "Contact message successfully sent", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Contact message successfully sent" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "The given data was invalid." } }, "type": "object" } }, "type": "object" } } } }, "403": { "description": "Email has already submitted a message today", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "You have already submitted a message today." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing your request." }, "error": { "type": "string", "example": "Detailed error message" } }, "type": "object" } }, "type": "object" } } } } } } }, "/api/user/get-topics": { "get": { "tags": [ "notification" ], "summary": "Get all topics with subscription status", "description": "Retrieve all topics available in the database along with their subscription status for the authenticated user.", "operationId": "getTopics", "responses": { "200": { "description": "Topics retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Topics retrieved successfully." }, "topics": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "topic_name": { "type": "string", "example": "Introduction to Biology" }, "description": { "type": "string", "example": "A foundational topic covering basic biology concepts." }, "is_subscribed": { "type": "boolean", "example": true }, "created_at": { "type": "string", "format": "date-time", "example": "2023-01-01T12:34:56Z" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "No topics found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "No topics found." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred while fetching topics", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while fetching topics." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/home-dashboard-section-position": { "get": { "tags": [ "user" ], "summary": "Retrieve dashboard sections", "description": "Fetches a list of dashboard sections for the authenticated user, ordered by position.", "operationId": "57ccb8841a24ec66d5159a9479804884", "responses": { "200": { "description": "Successfully retrieved dashboard sections", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "topics": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "section_name": { "type": "string", "example": "Featured Products" }, "position": { "type": "integer", "example": 1 }, "enable": { "type": "boolean", "example": true } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "No sections found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "No Section found." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error occurred while fetching topics", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while fetching topics." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/topic-subscription": { "post": { "tags": [ "notification" ], "summary": "Manage topic subscription", "description": "Subscribe or unsubscribe a user to a specific topic. If the subscription exists, it will be updated. If not, a new subscription will be created.", "operationId": "TopicSubscription", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "topic_id", "subscribed" ], "properties": { "topic_id": { "type": "integer", "example": 101 }, "subscribed": { "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Subscription updated or removed successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Topic subscription removed successfully." }, "subscription": { "properties": { "user_id": { "type": "integer", "example": 1 }, "topic_id": { "type": "integer", "example": 101 }, "subscribed": { "type": "boolean", "example": false } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "201": { "description": "Subscription created successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Topic subscription created successfully." }, "subscription": { "properties": { "user_id": { "type": "integer", "example": 1 }, "topic_id": { "type": "integer", "example": 101 }, "subscribed": { "type": "boolean", "example": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Validation error." }, "errors": { "type": "object", "additionalProperties": { "type": "string", "example": "The topic_id field is required.", "property": null } } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Topic not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "The specified topic does not exist." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while processing the topic subscription." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/get-notifications": { "get": { "tags": [ "notification" ], "summary": "Get user notifications", "description": "Retrieve paginated notifications for the authenticated user, filtered by receiver_id or topic subscriptions.", "operationId": "getNotifications", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 2 } } ], "responses": { "200": { "description": "Notifications retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Notifications retrieved successfully." }, "notifications": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 4 }, "topic_id": { "type": "integer", "example": 0 }, "sender_id": { "type": "integer", "example": 1 }, "receiver_id": { "type": "integer", "example": 225 }, "message": { "type": "string", "example": "You have a new message." }, "image": { "type": "string", "example": null }, "status": { "type": "integer", "example": 1 }, "created_at": { "type": "string", "format": "date-time", "example": "2023-06-09T19:06:25.000000Z" } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "http://localhost:8000/api/user/get-notifications?page=1" }, "last_page": { "type": "integer", "example": 3 }, "last_page_url": { "type": "string", "example": "http://localhost:8000/api/user/get-notifications?page=3" }, "next_page_url": { "type": "string", "example": "http://localhost:8000/api/user/get-notifications?page=2" }, "path": { "type": "string", "example": "http://localhost:8000/api/user/get-notifications" }, "per_page": { "type": "integer", "example": 5 }, "prev_page_url": { "type": "string", "example": null }, "total": { "type": "integer", "example": 11 } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "No notifications found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "No notifications found." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred while fetching notifications", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while fetching notifications." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/notifications-read/{id}": { "get": { "tags": [ "notification" ], "summary": "Mark notification as read", "description": "Set the status of a notification to read (1) for the authenticated user.", "operationId": "markNotificationAsRead", "parameters": [ { "name": "id", "in": "path", "description": "ID of the notification to be marked as read", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Notification marked as read successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Notification marked as read successfully." } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Notification not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Notification not found." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred while marking notification as read", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while marking notification as read." }, "error": { "type": "string", "example": "Error details here" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/notifications/delete/{id}": { "get": { "tags": [ "Notifications" ], "summary": "Delete a user notification", "description": "Delete a specific notification by its ID if it belongs to the authenticated user.", "operationId": "deleteNotification", "parameters": [ { "name": "id", "in": "path", "description": "ID of the notification to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Notification deleted successfully.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "properties": { "message": { "type": "string", "example": "Notification deleted successfully." } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Notification not found.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "Notification not found." } }, "type": "object" } }, "type": "object" } } } }, "500": { "description": "An error occurred while deleting the notification.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "data": { "properties": { "message": { "type": "string", "example": "An error occurred while deleting the notification." }, "error": { "type": "string", "example": "Exception message" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/user/all_sliders": { "get": { "tags": [ "user" ], "summary": "Get all sliders", "description": "Fetches all sliders including details like name, description, link, start date, end date, status, and timestamps.", "operationId": "bd11aad8f8c212f8089d6315c8484918", "responses": { "200": { "description": "Successfully retrieved sliders", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Slider 1" }, "description": { "type": "string", "example": "This is a description of slider 1." }, "type": { "type": "string", "example": "web,testseries" }, "link": { "type": "string", "example": "https://example.com" }, "start_date": { "type": "string", "format": "date", "example": "2024-09-01" }, "end_date": { "type": "string", "format": "date", "example": "2024-09-30" }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-08-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-08-15T12:00:00Z" } }, "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred while processing the request." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } } }, "tags": [ { "name": "Guest user", "description": "Guest user" }, { "name": "Authentication", "description": "Authentication" }, { "name": "tutor", "description": "tutor" }, { "name": "Master", "description": "Master" }, { "name": "user", "description": "user" }, { "name": "notification", "description": "notification" }, { "name": "Notifications", "description": "Notifications" } ], "components": { "securitySchemes": { "sanctum": { "type": "apiKey", "description": "Enter your bearer token in the format (Bearer )", "name": "Authorization", "in": "header" } } } }