-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_data.js
674 lines (674 loc) · 23.9 KB
/
api_data.js
1
define({ "api": [ { "group": "MEETING", "version": "1.0.0", "type": "get", "url": "/api/v1/meeting/getall", "title": "api for geting all meeting.", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"All Meeting Details Found\",\n \"status\": 200,\n \"data\": [\n {\n \"_id\": \"5c5e94c4244b4d0c474733da\",\n \"createdOn\": \"2019-02-09T08:52:20.000Z\",\n \"color\": \"#aa7942\",\n \"title\": \"hello\",\n \"end\": \"2019-02-09T13:00:00.000Z\",\n \"start\": \"2019-02-09T12:00:00.000Z\",\n \"setBy\": \"vivek surushe\",\n \"meetId\": \"K4sNKV4kv\",\n \"__v\": 0\n },\n {\n \"_id\": \"5c5e953d244b4d0c474733db\",\n \"createdOn\": \"2019-02-09T08:54:21.000Z\",\n \"color\": \"#00f900\",\n \"title\": \"new one\",\n \"end\": \"2019-02-09T14:00:00.000Z\",\n \"start\": \"2019-02-09T13:00:00.000Z\",\n \"setBy\": \"vivek surushe\",\n \"meetId\": \"OHBoD5op3\",\n \"__v\": 0\n }\n ]\n}", "type": "object" } ] }, "filename": "app/routes/meeting.js", "groupTitle": "MEETING", "name": "GetApiV1MeetingGetall" }, { "group": "MEETING", "version": "1.0.0", "type": "post", "url": "/api/v1/meeting/delete", "title": "to Delete Meeting.", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "meetId", "description": "<p>Meeting Id of perticular meeting.(body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Meeting Deleted Successfully\",\n \"status\": 200,\n \"data\": null\n}", "type": "object" } ] }, "filename": "app/routes/meeting.js", "groupTitle": "MEETING", "name": "PostApiV1MeetingDelete" }, { "group": "MEETING", "version": "1.0.0", "type": "post", "url": "/api/v1/meeting/getUserMeet", "title": "to get specific user meeting.", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "userId", "description": "<p>of the user.(body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Users All Meeting Details Found\",\n \"status\": 200,\n \"data\": [\n {\n \"_id\": \"5c5ea560cd4b700cf9c254e5\",\n \"createdOn\": \"2019-02-09T10:03:12.000Z\",\n \"color\": \"#ff40ff\",\n \"title\": \"js\",\n \"end\": \"2019-02-20T12:00:00.000Z\",\n \"start\": \"2019-02-19T12:00:00.000Z\",\n \"setBy\": \"vivek surushe\",\n \"meetId\": \"nrFdbtRnd\",\n \"__v\": 0\n },\n {\n \"_id\": \"5c62787b910e75fc0433f7b9\",\n \"updatedOn\": null,\n \"createdOn\": \"2019-02-12T07:40:43.000Z\",\n \"color\": \"#0433ff\",\n \"purpose\": \"purpose of meeting\",\n \"where\": \"mumbai\",\n \"title\": \"all are here\",\n \"end\": \"2019-02-20T14:00:00.000Z\",\n \"start\": \"2019-02-20T12:00:00.000Z\",\n \"forAll\": \"\",\n \"setTo\": \"all\",\n \"setBy\": \"viveks Surushe\",\n \"meetId\": \"d4fguYssO\",\n \"__v\": 0\n }\n ]\n}", "type": "object" } ] }, "filename": "app/routes/meeting.js", "groupTitle": "MEETING", "name": "PostApiV1MeetingGetusermeet" }, { "group": "MEETING", "version": "1.0.0", "type": "post", "url": "/api/v1/meeting/save", "title": "to Create new meeting.", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "setBy", "description": "<p>meeting setBy.(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "setTo", "description": "<p>meeting Set to user(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "title", "description": "<p>title of the meeting(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "purpose", "description": "<p>purpose of meeting(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "where", "description": "<p>location (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "meeting", "description": "<p>start time (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "end", "description": "<p>meetnig end time (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "color", "description": "<p>Calender color meeting(body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Meeting created\",\n \"status\": 200,\n \"data\": {\n \"__v\": 0,\n \"_id\": \"5c62abd4247a292cca570f8b\",\n \"updatedOn\": null,\n \"createdOn\": \"2019-02-12T11:19:48.000Z\",\n \"color\": \"#ff0000\",\n \"purpose\": \"testing\",\n \"where\": \"at home\",\n \"title\": \"postman\",\n \"end\": \"2019-02-20T14:00:00.000Z\",\n \"start\": \"2019-02-20T13:00:00.000Z\",\n \"setTo\": \"all\",\n \"setBy\": \"vivek surushe\",\n \"meetId\": \"BnGt4Iazg\"\n }\n}", "type": "object" } ] }, "filename": "app/routes/meeting.js", "groupTitle": "MEETING", "name": "PostApiV1MeetingSave" }, { "group": "MEETING", "version": "1.0.0", "type": "post", "url": "/api/v1/meeting/update", "title": "to update Meeting.", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "setBy", "description": "<p>meeting setBy.(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "setTo", "description": "<p>meeting Set to user(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "title", "description": "<p>title of the meeting(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "purpose", "description": "<p>purpose of meeting(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "where", "description": "<p>location (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "start", "description": "<p>start time (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "end", "description": "<p>meetnig end time (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "color", "description": "<p>Calender color meeting(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "meetId", "description": "<p>meeting that tobe updated(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "email", "description": "<p>to send Notification on mail(body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Meeting Updated with Mail Send Successful\",\n \"status\": 200,\n \"data\": null\n}", "type": "object" } ] }, "filename": "app/routes/meeting.js", "groupTitle": "MEETING", "name": "PostApiV1MeetingUpdate" }, { "group": "USERS", "version": "1.0.0", "type": "get", "url": "/api/v1/users/members", "title": "api for geting all users.", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Users Found\",\n \"status\": 200,\n \"data\": [\n {\n \"_id\": \"5c5ffd9c77d71a27660268e0\",\n \"lastName\": \"Shelke\",\n \"firstName\": \"Balaji\",\n \"userId\": \"B_VOhRflU\"\n },\n {\n \"_id\": \"5c61bdadd63e37a2865ef771\",\n \"lastName\": \"LastName\",\n \"firstName\": \"firstName\",\n \"userId\": \"Wuc6LydE7\"\n },\n {\n \"_id\": \"5c62a0ca29d86c21ea76bfd5\",\n \"lastName\": \"Kore\",\n \"firstName\": \"Nutan\",\n \"userId\": \"HGY2eMlOa\"\n }\n ]\n}", "type": "object" } ] }, "filename": "app/routes/user.js", "groupTitle": "USERS", "name": "GetApiV1UsersMembers" }, { "group": "USERS", "version": "1.0.0", "type": "post", "url": "/api/v1/users/getCode", "title": "to get verification code to user", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "email", "description": "<p>of the user.(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "userId", "description": "<p>of the user.(body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Verification Code Found\",\n \"status\": 200,\n \"data\": {\n \"_id\": \"5c62a0ca29d86c21ea76bfd5\",\n \"__v\": 0,\n \"createdOn\": \"2019-02-12T10:32:42.000Z\",\n \"verifiCode\": \"MS0p0l7kG\",\n \"password\": \"$2a$10$aScrAsd9IOJv1bvgJfP6/.koaQFVpGt4PKGjR15vRVnhftpN4JugC\",\n \"role\": \"user\",\n \"phone\": 9812131412,\n \"countyCode\": \"91\",\n \"email\": \"nutan@gmail.com\",\n \"lastName\": \"Kore\",\n \"firstName\": \"Nutan\",\n \"userId\": \"HGY2eMlOa\"\n }\n}", "type": "object" } ] }, "filename": "app/routes/user.js", "groupTitle": "USERS", "name": "PostApiV1UsersGetcode" }, { "group": "USERS", "version": "1.0.0", "type": "post", "url": "/api/v1/users/login", "title": "to login user.", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "email", "description": "<p>email of the user.(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "password", "description": "<p>password of the user.(body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Login Successful\",\n \"status\": 200,\n \"data\": {\n \"authToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqd3RpZCI6IlJTVHdnekQwZSIsImlhdCI6MTU0OTk2Nzg0MDk1NCwiZXhwIjoxNTUwMDU0MjQwLCJzdWIiOiJhdXRoVG9rZW4iLCJpc3MiOiJlZENoYXQiLCJkYXRhIjp7InZlcmlmaUNvZGUiOiIiLCJyb2xlIjoidXNlciIsInBob25lIjo5ODEyMTMxNDEyLCJjb3VudHlDb2RlIjoiOTEiLCJlbWFpbCI6Im51dGFuQGdtYWlsLmNvbSIsImxhc3ROYW1lIjoiS29yZSIsImZpcnN0TmFtZSI6Ik51dGFuIiwidXNlcklkIjoiSEdZMmVNbE9hIn19.MePP2M-AQ-PZXcpe0FmOpncgL-JXj1ph6o9Ca7dKhZA\",\n \"userDetails\": {\n \"verifiCode\": \"\",\n \"role\": \"user\",\n \"phone\": 9812131412,\n \"countyCode\": \"91\",\n \"email\": \"nutan@gmail.com\",\n \"lastName\": \"Kore\",\n \"firstName\": \"Nutan\",\n \"userId\": \"HGY2eMlOa\"\n }\n }\n}", "type": "object" } ] }, "filename": "app/routes/user.js", "groupTitle": "USERS", "name": "PostApiV1UsersLogin" }, { "group": "USERS", "version": "1.0.0", "type": "post", "url": "/api/v1/users/logout", "title": "to logout user.", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "userId", "description": "<p>userId of the user.(body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Logged Out Successfully\",\n \"status\": 200,\n \"data\": null\n}", "type": "object" } ] }, "filename": "app/routes/user.js", "groupTitle": "USERS", "name": "PostApiV1UsersLogout" }, { "group": "USERS", "version": "1.0.0", "type": "post", "url": "/api/v1/users/sendVeriCode", "title": "to send verification code to user", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "email", "description": "<p>email of the user.(body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Mail Send Successful\",\n \"status\": 200,\n \"data\": null\n}", "type": "object" } ] }, "filename": "app/routes/user.js", "groupTitle": "USERS", "name": "PostApiV1UsersSendvericode" }, { "group": "USERS", "version": "1.0.0", "type": "post", "url": "/api/v1/users/signup", "title": "api for user signup.", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "firstName", "description": "<p>firstName of the user. (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "lastName", "description": "<p>lastName of the user. (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "email", "description": "<p>email of the user. (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "countyCode", "description": "<p>countyCode of the user. (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "phone", "description": "<p>Phone Number of the user. (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "role", "description": "<p>role of the user. (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "password", "description": "<p>password of the user. (body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "passConf", "description": "<p>passConf of the user. (body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"User created\",\n \"status\": 200,\n \"data\": {\n \"__v\": 0,\n \"_id\": \"5c62a0ca29d86c21ea76bfd5\",\n \"createdOn\": \"2019-02-12T10:32:42.000Z\",\n \"verifiCode\": \"\",\n \"role\": \"user\",\n \"phone\": 9812131412,\n \"countyCode\": \"91\",\n \"email\": \"nutan@gmail.com\",\n \"lastName\": \"Kore\",\n \"firstName\": \"Nutan\",\n \"userId\": \"HGY2eMlOa\"\n }\n}", "type": "object" } ] }, "filename": "app/routes/user.js", "groupTitle": "USERS", "name": "PostApiV1UsersSignup" }, { "group": "USERS", "version": "1.0.0", "type": "post", "url": "/api/v1/users/updatePass", "title": "to update password of the user", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "email", "description": "<p>email of the user.(body params) (required)</p>" }, { "group": "Parameter", "type": "string", "optional": false, "field": "newpassword", "description": "<p>new password of the user.(body params) (required)</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "myResponse", "description": "<p>shows error status, message, http status code, result.</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"error\": false,\n \"message\": \"Password Updated SuccessFully\",\n \"status\": 200,\n \"data\": null\n}", "type": "object" } ] }, "filename": "app/routes/user.js", "groupTitle": "USERS", "name": "PostApiV1UsersUpdatepass" }] });