{ "swagger": "2.0", "info": { "title": "hugoHealth-Api-Docs", "version": "1.0.0" }, "basePath": "/api/v1", "schemas": [ "http" ], "paths": { "/user/index": { "get": { "tags": [ "user" ], "description": "fetch data by /user/index", "produces": [ "application/json" ], "consumes": [ null ], "parameters": [], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/indexResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/user/generateOtp": { "post": { "tags": [ "user" ], "description": "fetch data by /user/generateOtp", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "Body", "in": "body", "description": "please enter code", "required": false, "schema": { "$ref": "#/definitions/generateOtp" } } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/generateOtpResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/user/login": { "post": { "tags": [ "user" ], "description": "fetch data by /user/login", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "Body", "in": "body", "description": "please enter code", "required": false, "schema": { "$ref": "#/definitions/login" } } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/loginResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/health/addPrescription": { "post": { "tags": [ "health" ], "description": "fetch data by /health/addPrescription", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "Body", "in": "body", "description": "please enter code", "required": false, "schema": { "$ref": "#/definitions/addPrescription" } } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/addPrescriptionResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/health/editPrescription": { "post": { "tags": [ "health" ], "description": "fetch data by /health/editPrescription", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "Body", "in": "body", "description": "please enter code", "required": false, "schema": { "$ref": "#/definitions/editPrescription" } } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/editPrescriptionResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/appointment/getUserAppointment": { "get": { "tags": [ "appointment" ], "description": "fetch data by /appointment/getUserAppointment", "produces": [ "application/json" ], "consumes": [ null ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "startDate", "in": "query", "description": "please enter startDate", "example": "2024-12-06", "required": false }, { "name": "type", "in": "query", "description": "please enter type", "example": "online", "required": false } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/getUserAppointmentResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/appointment/doctorAppointmentList": { "get": { "tags": [ "appointment" ], "description": "fetch data by /appointment/doctorAppointmentList", "produces": [ "application/json" ], "consumes": [ null ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "startDate", "in": "query", "description": "please enter startDate", "example": "2024-12-09", "required": false } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/doctorAppointmentListResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/appointment/slots": { "get": { "tags": [ "appointment" ], "description": "fetch data by /appointment/slots", "produces": [ "application/json" ], "consumes": [ null ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "date", "in": "query", "description": "please enter date", "example": "2024-12-09", "required": false }, { "name": "doctorId", "in": "query", "description": "please enter doctorId", "example": "675293d08a6a89eec064b794", "required": false } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/slotsResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/appointment/get-doctor-list": { "get": { "tags": [ "appointment" ], "description": "fetch data by /appointment/get-doctor-list", "produces": [ "application/json" ], "consumes": [ null ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "please enter search", "example": "hem", "required": false } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/get-doctor-listResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/appointment/book-appotiment": { "post": { "tags": [ "appointment" ], "description": "fetch data by /appointment/book-appotiment", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "Body", "in": "body", "description": "please enter code", "required": false, "schema": { "$ref": "#/definitions/book-appotiment" } } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/book-appotimentResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/appointment/attachPatientToAppointment": { "post": { "tags": [ "appointment" ], "description": "fetch data by /appointment/attachPatientToAppointment", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "Body", "in": "body", "description": "please enter code", "required": false, "schema": { "$ref": "#/definitions/attachPatientToAppointment" } } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/attachPatientToAppointmentResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/health/getUserPrescription": { "get": { "tags": [ "health" ], "description": "fetch data by /health/getUserPrescription", "produces": [ "application/json" ], "consumes": [ null ], "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token", "required": true, "type": "string" }, { "name": "appointmentId", "in": "query", "description": "please enter appointmentId", "example": "676ea43cb5f2f6f54ac56045", "required": false } ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/getUserPrescriptionResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/errorResponse" } } } } } }, "definitions": { "errorResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "success status", "example": false }, "message": { "type": "string", "description": "something is wrong", "example": "something is wrong" } } }, "indexResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "api routes working properly ❤", "example": "api routes working properly ❤" } } }, "generateOtp": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "Enter countryCode", "example": "91" }, "mobile": { "type": "string", "description": "Enter mobile", "example": "7777777777" } } }, "generateOtpResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "OTP sent successfully", "example": "OTP sent successfully" }, "data": { "type": "object", "description": "Successfully Data", "example": { "countryCode": "91", "mobile": "7777777777" } } } }, "login": { "type": "object", "properties": { "mobile": { "type": "string", "description": "Enter mobile", "example": "1234567898" }, "otp": { "type": "string", "description": "Enter otp", "example": "1234" } } }, "loginResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "User login Successfully.", "example": "User login Successfully." }, "data": { "type": "object", "description": "Successfully Data", "example": { "_id": "67515a2754a7f88561f61fee", "auth": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NzUxNWEyNzU0YTdmODg1NjFmNjFmZWUiLCJpYXQiOjE3MzMzODQ3NTB9.Sgvd5f2TCL0YEWu5lWCsIQTqK2af3x9R0NPjFlaTx_I" } } } }, "addPrescription": { "type": "object", "properties": { "patientId": { "type": "string", "description": "Enter patientId", "example": "6735cacdf3a370a2115d02f8" }, "appointmentId": { "type": "string", "description": "Enter appointmentId", "example": "6752e670ae6f15a3cc3970bb" }, "diagnosis": { "type": "string", "description": "Enter diagnosis", "example": "Fever and cold" }, "medicines": { "type": "object", "description": "Enter medicines", "example": [ { "name": "Paracetamol", "doses": "500mg", "frequency": "Twice a day", "instructions": "After meals" }, { "name": "Cough Syrup", "doses": "10ml", "frequency": "Three times a day", "instructions": "Before meals" } ] }, "advice": { "type": "string", "description": "Enter advice", "example": "Drink plenty of fluids and rest." }, "doctorId": { "type": "object", "description": "Enter doctorId", "example": "675293d08a6a89eec064b794" }, "userId": { "type": "object", "description": "Enter userId", "example": "6735bc05a4a8be1302a92bea" } } }, "addPrescriptionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "Prescription Added Successfully", "example": "Prescription Added Successfully" }, "data": { "type": "object", "description": "Successfully Data", "example": { "patientId": "6735cacdf3a370a2115d02f8", "appointmentId": "6752e670ae6f15a3cc3970bb", "diagnosis": "Fever and cold", "medicines": [ { "name": "Paracetamol", "doses": "500mg", "frequency": "Twice a day", "instructions": "After meals" }, { "name": "Cough Syrup", "doses": "10ml", "frequency": "Three times a day", "instructions": "Before meals" } ], "advice": "Drink plenty of fluids and rest.", "doctorId": "675293d08a6a89eec064b794", "userId": "6735bc05a4a8be1302a92bea" } } } }, "editPrescription": { "type": "object", "properties": { "id": { "type": "string", "description": "Enter id", "example": "67515d2eab65a93a3a657929" }, "diagnosis": { "type": "string", "description": "Enter diagnosis", "example": "Fever and cold" }, "medicines": { "type": "object", "description": "Enter medicines", "example": [ { "name": "Paracetamol", "doses": "500mg", "frequency": "Twice a day", "instructions": "After meals" } ] }, "advice": { "type": "string", "description": "Enter advice", "example": "Drink plenty of fluids and rest." } } }, "editPrescriptionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "Prescription Updated Successfully", "example": "Prescription Updated Successfully" }, "data": { "type": "object", "description": "Successfully Data", "example": { "id": "67515d2eab65a93a3a657929", "diagnosis": "Fever and cold", "medicines": [ { "name": "Paracetamol", "doses": "500mg", "frequency": "Twice a day", "instructions": "After meals" } ], "advice": "Drink plenty of fluids and rest." } } } }, "getUserAppointmentResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "Appointment List", "example": "Appointment List" }, "data": { "type": "object", "description": "Successfully Data", "example": { "pagination": { "totalChildrenCount": 3, "totalPages": null, "page": null, "perPage": null }, "documents": [ { "_id": "67529f3b7642c850edddd583", "patientId": "67529d797642c850edddd570", "userId": "67529d3b7642c850edddd565", "specializationId": "672de840f1085b1a071fd0f5", "type": "online", "status": "not-accepted", "date": "2024-12-06T06:52:43.575Z", "doctor": [], "patientName": "abccc", "patientAge": "22", "patientGender": "male", "userMobile": "8947027674" }, { "_id": "6752a3437642c850edddd59a", "patientId": "67529d797642c850edddd570", "userId": "67529d3b7642c850edddd565", "specializationId": "672de840f1085b1a071fd0f5", "type": "online", "status": "accepted", "doctorId": "675293d08a6a89eec064b794", "date": "2024-12-06T07:09:55.125Z", "doctor": [ { "_id": "675293d08a6a89eec064b794", "uniqueNumber": "15602185360522", "registrationNumber": "10", "mobile": "9876543210", "role": "doctor", "appointmentMode": "both", "name": "Sunil", "specialization": "Hematology", "state": "Rajasthan", "City": "Asind", "Pincode": "202222", "Language": "hindi", "Gender": "male", "Age": 20, "images": [] } ], "patientName": "abccc", "patientAge": "22", "patientGender": "male", "userMobile": "8947027674" }, { "_id": "6752c56239d92dd147426c31", "patientId": "67529d797642c850edddd570", "userId": "67529d3b7642c850edddd565", "specializationId": "672de840f1085b1a071fd0f5", "date": "2024-12-06T09:35:30.516Z", "type": "online", "status": "not-accepted", "doctor": [], "patientName": "abccc", "patientAge": "22", "patientGender": "male", "userMobile": "8947027674" } ] } } } }, "doctorAppointmentListResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "Appointment List", "example": "Appointment List" }, "data": { "type": "object", "description": "Successfully Data", "example": { "pagination": { "totalChildrenCount": 2, "totalPages": null, "page": null, "perPage": null }, "documents": [ { "_id": "67529ca87642c850edddd55a", "doctorId": "675293d08a6a89eec064b794", "userId": "6735bc05a4a8be1302a92bea", "date": "2024-12-09T00:00:00.000Z", "slot": { "start": "14:30", "end": "14:40" }, "type": "offline", "status": "booked", "patientId": "675289aa52b35679bd938025", "patientName": "new", "patientAge": "22", "patientGender": "male", "userMobile": "8947027673" }, { "_id": "67529d657642c850edddd56d", "doctorId": "675293d08a6a89eec064b794", "userId": "67529d3b7642c850edddd565", "date": "2024-12-09T00:00:00.000Z", "slot": { "start": "15:00", "end": "15:10" }, "type": "offline", "status": "booked", "patientId": "67529d797642c850edddd570", "patientName": "abccc", "patientAge": "22", "patientGender": "male", "userMobile": "8947027674" } ] } } } }, "slotsResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "Slot List", "example": "Slot List" }, "data": { "type": "object", "description": "Successfully Data", "example": [ { "_id": "67529b9565d98a50a3b16ed8", "doctorId": "675293d08a6a89eec064b794", "slots": [ { "start": "09:30", "end": "09:40", "duration": 10, "isBooked": false }, { "start": "09:40", "end": "09:50", "duration": 10, "isBooked": false }, { "start": "09:50", "end": "10:00", "duration": 10, "isBooked": false }, { "start": "10:00", "end": "10:10", "duration": 10, "isBooked": false }, { "start": "10:10", "end": "10:20", "duration": 10, "isBooked": false }, { "start": "10:20", "end": "10:30", "duration": 10, "isBooked": false }, { "start": "10:30", "end": "10:40", "duration": 10, "isBooked": false }, { "start": "10:40", "end": "10:50", "duration": 10, "isBooked": false }, { "start": "10:50", "end": "11:00", "duration": 10, "isBooked": false }, { "start": "11:00", "end": "11:10", "duration": 10, "isBooked": false }, { "start": "11:10", "end": "11:20", "duration": 10, "isBooked": false }, { "start": "11:20", "end": "11:30", "duration": 10, "isBooked": false }, { "start": "11:30", "end": "11:40", "duration": 10, "isBooked": false }, { "start": "11:40", "end": "11:50", "duration": 10, "isBooked": false }, { "start": "11:50", "end": "12:00", "duration": 10, "isBooked": false }, { "start": "12:00", "end": "12:10", "duration": 10, "isBooked": false }, { "start": "12:10", "end": "12:20", "duration": 10, "isBooked": false }, { "start": "12:20", "end": "12:30", "duration": 10, "isBooked": false }, { "start": "12:30", "end": "12:40", "duration": 10, "isBooked": false }, { "start": "12:40", "end": "12:50", "duration": 10, "isBooked": false }, { "start": "12:50", "end": "13:00", "duration": 10, "isBooked": false } ] } ] } } }, "get-doctor-listResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "Doctor List", "example": "Doctor List" }, "data": { "type": "object", "description": "Successfully Data", "example": { "pagination": { "totalChildrenCount": 3, "totalPages": null, "page": null, "perPage": null }, "documents": [ { "_id": "675294688a6a89eec064b7a7", "uniqueNumber": "15602186736001", "registrationNumber": "23", "mobile": "9887654321", "role": "doctor", "appointmentMode": "both", "isOnlineBySelf": true, "isOnlineByAdmin": true, "name": "preetam", "Pincode": "234567", "Language": "hindi", "Gender": "male", "Age": 30, "images": [], "isClicnic": false, "isDeleted": false, "createdAt": "2024-12-06T06:06:32.938Z", "specialization": "Hematology", "City": "Buriya", "state": "Haryana" }, { "_id": "6752943d8a6a89eec064b7a2", "uniqueNumber": "15602186345230", "registrationNumber": "21", "mobile": "9987654321", "role": "doctor", "appointmentMode": "both", "isOnlineBySelf": true, "isOnlineByAdmin": true, "name": "rinku", "Pincode": "234567", "Language": "hindi", "Gender": "male", "Age": 79, "images": [], "isClicnic": false, "isDeleted": false, "createdAt": "2024-12-06T06:05:49.516Z", "specialization": "Hematology", "City": "Jaipur", "state": "Rajasthan" }, { "_id": "675293d08a6a89eec064b794", "uniqueNumber": "15602185360522", "registrationNumber": "10", "mobile": "9876543210", "role": "doctor", "appointmentMode": "both", "isOnlineBySelf": true, "isOnlineByAdmin": true, "name": "Sunil", "Pincode": "202222", "Language": "hindi", "Gender": "male", "Age": 20, "images": [], "isClicnic": false, "isDeleted": false, "createdAt": "2024-12-06T06:04:00.118Z", "specialization": "Hematology", "City": "Asind", "state": "Rajasthan" } ] } } } }, "book-appotiment": { "type": "object", "properties": { "doctorId": { "type": "string", "description": "Enter doctorId", "example": "675293d08a6a89eec064b794" }, "slot": { "type": "object", "description": "Enter slot", "example": { "start": "14:40", "end": "14:50" } }, "date": { "type": "string", "description": "Enter date", "example": "2024-12-10" }, "type": { "type": "string", "description": "Enter type", "example": "offline" }, "status": { "type": "string", "description": "Enter status", "example": "booked" }, "userId": { "type": "object", "description": "Enter userId", "example": "6735bc05a4a8be1302a92bea" } } }, "book-appotimentResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "Appointment Booked Successfully", "example": "Appointment Booked Successfully" }, "data": { "type": "object", "description": "Successfully Data", "example": { "doctorId": "675293d08a6a89eec064b794", "userId": "6735bc05a4a8be1302a92bea", "date": "2024-12-10T00:00:00.000Z", "slot": { "start": "14:40", "end": "14:50" }, "type": "offline", "status": "booked", "_id": "6752e670ae6f15a3cc3970bb", "doctorAttempts": [], "createdAt": "2024-12-06T11:56:32.254Z", "updatedAt": "2024-12-06T11:56:32.254Z" } } } }, "attachPatientToAppointment": { "type": "object", "properties": { "patientId": { "type": "string", "description": "Enter patientId", "example": "6752e4e6986a09d0b0fb3735" }, "appointmentId": { "type": "string", "description": "Enter appointmentId", "example": "6752e670ae6f15a3cc3970bb" } } }, "attachPatientToAppointmentResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "Patient add to Apponiment", "example": "Patient add to Apponiment" } } }, "getUserPrescriptionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "true", "example": true }, "message": { "type": "string", "description": "Prescription List", "example": "Prescription List" }, "data": { "type": "object", "description": "Successfully Data", "example": { "_id": "6752ef3d260724f441f5e450", "diagnosis": "Fever and cold", "medicines": [ { "name": "Paracetamol", "doses": "500mg", "frequency": "Twice a day", "instructions": "After meals", "_id": "6752ef3d260724f441f5e451" }, { "name": "Cough Syrup", "doses": "10ml", "frequency": "Three times a day", "instructions": "Before meals", "_id": "6752ef3d260724f441f5e452" } ], "advice": "Drink plenty of fluids and rest.", "doctor": { "_id": "675293d08a6a89eec064b794", "mobile": "9876543210", "appointmentMode": "both", "name": "Sunil", "specialization": "Hematology", "Gender": "male", "Age": "20" }, "isSelf": null, "date": null, "patientName": "hitesh Sekawat", "patientAge": "23", "patientGender": "male", "userMobile": "8947027673" } } } } } }