+ Download OpenAPI specification:Download +
+{context}/mentoring/v1 -
+ Note: These resources can be used in other services
+ This API is associated with creating a form
+/mentoring/v1/form/createrequired
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
|
+ type
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ subType
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ action
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ ver
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+
+ required
+ |
+
+
+
+
+ object
+
+
+ |
+
{
+
+ -
+
+ "type":
+ "profile",
+
+
+ -
+
+ "subType":
+ "profileForm",
+
+
+ -
+
+ "action":
+ "profileFields",
+
+
+ -
+
+ "ver":
+ "1.0",
+
+
+ -
+
+ "data":
+ {
+
+ -
+
+ "templateName":
+ "defaultTemplate",
+
+
+ -
+
+ "fields":
+ {
+
+ -
+
+ "controls":
+ [
+
+ -
+
+ {
+
+ -
+
+ "name":
+ "name",
+
+
+ -
+
+ "label":
+ "name",
+
+
+ -
+
+ "value":
+ "",
+
+
+ -
+
+ "class":
+ "ion-margin",
+
+
+ -
+
+ "type":
+ "text",
+
+
+ -
+
+ "position":
+ "floating",
+
+
+ -
+
+ "validators":
+ {
+
+ -
+
+ "required":
+ true,
+
+
+ -
+
+ "minLength":
+ 10
+
+
+
+ }
+
+
+
+ }
+
+
+
+ ]
+
+
+
+ }
+
+
+
+ }
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Form created
+ successfully",
+
+
+ -
+
+ "result":
+ [ ]
+
+
+
+ }
+ This API is associated with updating a form
+/mentoring/v1/form/updaterequired
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
|
+ type
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ subType
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ action
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ ver
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+
+ required
+ |
+
+
+
+
+ object
+
+
+ |
+
{
+
+ -
+
+ "type":
+ "profile",
+
+
+ -
+
+ "subType":
+ "profileForm",
+
+
+ -
+
+ "action":
+ "profileFields",
+
+
+ -
+
+ "ver":
+ "1.0",
+
+
+ -
+
+ "data":
+ {
+
+ -
+
+ "templateName":
+ "defaultTemplate",
+
+
+ -
+
+ "fields":
+ {
+
+ -
+
+ "controls":
+ [
+
+ -
+
+ {
+
+ -
+
+ "name":
+ "name",
+
+
+ -
+
+ "label":
+ "name",
+
+
+ -
+
+ "value":
+ "",
+
+
+ -
+
+ "class":
+ "ion-margin",
+
+
+ -
+
+ "type":
+ "text",
+
+
+ -
+
+ "position":
+ "floating",
+
+
+ -
+
+ "validators":
+ {
+
+ -
+
+ "required":
+ true,
+
+
+ -
+
+ "minLength":
+ 10
+
+
+
+ }
+
+
+
+ }
+
+
+
+ ]
+
+
+
+ }
+
+
+
+ }
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Form updated
+ successfully",
+
+
+ -
+
+ "result":
+ [ ]
+
+
+
+ }
+ This API is associated with getting a form
+/mentoring/v1/form/readrequired
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
| + type + | +
+
+
+
+ string
+
+
+ |
+
| + subType + | +
+
+
+
+ string
+
+
+ |
+
| + action + | +
+
+
+
+ string
+
+
+ |
+
| + ver + | +
+
+
+
+ string
+
+
+ |
+
| + templateName + | +
+
+
+
+ string
+
+
+ |
+
{
+
+ -
+
+ "type":
+ "profile",
+
+
+ -
+
+ "subType":
+ "profileForm",
+
+
+ -
+
+ "action":
+ "profileFields",
+
+
+ -
+
+ "ver":
+ "1.0",
+
+
+ -
+
+ "templateName":
+ "defaultTemplate"
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Form fetched
+ successfully",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "type":
+ "profile",
+
+
+ -
+
+ "subType":
+ "profileForm",
+
+
+ -
+
+ "action":
+ "profileFields",
+
+
+ -
+
+ "ver":
+ "1.0",
+
+
+ -
+
+ "updatedAt":
+ "2022-05-24T23:14:10.080Z",
+
+
+ -
+
+ "createdAt":
+ "2022-05-24T23:14:10.080Z",
+
+
+ -
+
+ "__v":
+ 0,
+
+
+ -
+
+ "_id":
+ "628d66c28069a73506cb4b2d",
+
+
+ -
+
+ "data":
+ {
+
+ -
+
+ "templateName":
+ "defaultTemplate",
+
+
+ -
+
+ "fields":
+ {
+
+ -
+
+ "controls":
+ [
+
+ -
+
+ {
+
+ -
+
+ "name":
+ "name",
+
+
+ -
+
+ "label":
+ "name",
+
+
+ -
+
+ "value":
+ "",
+
+
+ -
+
+ "class":
+ "ion-margin",
+
+
+ -
+
+ "type":
+ "text",
+
+
+ -
+
+ "position":
+ "floating",
+
+
+ -
+
+ "validators":
+ {
+
+ -
+
+ "required":
+ true,
+
+
+ -
+
+ "minLength":
+ 10
+
+
+
+ }
+
+
+
+ }
+
+
+
+ ]
+
+
+
+ }
+
+
+
+ }
+
+
+
+ }
+
+
+
+ }
+ This API is associated with creating user entity
+/mentoring/v1/entity/create
+ required
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
|
+ value
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ label
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ type
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
{
+
+ -
+
+ "value":
+ "HM",
+
+
+ -
+
+ "label":
+ "Head Master",
+
+
+ -
+
+ "type":
+ "roles"
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "User entity created
+ successfully",
+
+
+ -
+
+ "result":
+ [ ]
+
+
+
+ }
+ This API is associated with update user entity
+/mentoring/v1/entity/updaterequired
+ |
+ id
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 62832531a05cbd57b273aebb
+
+
+
+
+
+ + Please append a valid user entity id To the Request + URL + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
|
+ value
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ label
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ status
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ type
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
{
+
+ -
+
+ "value":
+ "HM",
+
+
+ -
+
+ "label":
+ "Head Master",
+
+
+ -
+
+ "status":
+ "DISABLED",
+
+
+ -
+
+ "type":
+ "roles"
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "User entity updated
+ successfully",
+
+
+ -
+
+ "result":
+ [ ]
+
+
+
+ }
+ This API is associated with get user entity
+/mentoring/v1/entity/readrequired
+ |
+ type
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ roles
+
+
+
+
+
+ Please append a valid type of role + |
+
| + deleted + | +
+
+
+
+ string
+
+
+
+ Example:
+
+ false
+
+
+
+
+
+
+ Please append a deleted type eg. for deleted user
+ |
+
| + status + | +
+
+
+
+ string
+
+
+
+ Example:
+
+ ACTIVE
+
+
+
+
+
+
+ Please append a status of user eg. for active user
+ |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "User entity fetched
+ successfully",
+
+
+ -
+
+ "result":
+ [
+
+ -
+
+ {
+
+ -
+
+ "value":
+ "HM",
+
+
+ -
+
+ "label":
+ "Head
+ Master"
+
+
+
+ }
+
+
+
+ ]
+
+
+
+ }
+ This API is associated with delete user entity
+/mentoring/v1/entity/delete
+ required
+ |
+ id
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 62832531a05cbd57b273aebb
+
+
+
+
+
+ + Please append a valid user entity id To the Request + URL + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "User entity deleted
+ successfully",
+
+
+ -
+
+ "result":
+ [ ]
+
+
+
+ }
+ + This API is associated with listing session based on condition on mentoring +
+/mentoring/v1/sessions/list
+ required
+ | + page + | +
+
+
+
+ number
+
+
+
+ Example:
+
+ 1
+
+
+
+
+
+ Please add page number + |
+
| + limit + | +
+
+
+
+ number
+
+
+
+ Example:
+
+ 2
+
+
+
+
+
+ number of record to limit + |
+
| + status + | +
+
+
+
+ string
+
+
+
+ Example:
+
+ published,completed
+
+
+
+
+
+
+ Please append a status eg. for published user
+ |
+
| + search + | +
+
+
+
+ string
+
+
+
+ Example:
+
+ jhon
+
+
+
+
+
+ + Please search for author name or title of session + etc. + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Session fetched
+ successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "data":
+ [
+
+ -
+
+ {
+
+ -
+
+ "_id":
+ "628dae0fce0ce9359aeb8b23",
+
+
+ -
+
+ "title":
+ "Leadership5",
+
+
+ -
+
+ "description":
+ "Training
+ in
+ leadership",
+
+
+ -
+
+ "image":
+ [
+
+ -
+
+ "[\"users/1232s2133sdd1-12e2dasd3123.png\"]"
+
+
+
+ ],
+
+
+ -
+
+ "mentorName":
+ "Ankit",
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "startDate":
+ "2022-01-04
+ 18:00:00",
+
+
+ -
+
+ "endDate":
+ "2022-01-04
+ 18:30:00",
+
+
+ -
+
+ "endDateUtc":
+ "Invalid
+ date"
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "count":
+ 1
+
+
+
+ }
+
+
+
+ }
+ This API is associated with getting session details on mentoring
+/mentoring/v1/sessions/details
+ required
+ |
+ sessionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 62832531a05cbd57b273aebb
+
+
+
+
+
+ + Please append a valid sessionId To the Request URL + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Session fetched
+ successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "_id":
+ "628dae0fce0ce9359aeb8b23",
+
+
+ -
+
+ "title":
+ "Leadership5",
+
+
+ -
+
+ "description":
+ "Training in
+ leadership",
+
+
+ -
+
+ "recommendedFor":
+ [
+
+ -
+
+ "[{\"label\":\"HM\",
+ \"value\":
+ 1}]"
+
+
+
+ ],
+
+
+ -
+
+ "categories":
+ [
+
+ -
+
+ "[{\"label\":
+ \"label\",
+ \"value\":
+ \"value\"}]"
+
+
+
+ ],
+
+
+ -
+
+ "medium":
+ [
+
+ -
+
+ "[{\"label\":\"Hindi\",
+ \"value\":
+ 2
+ }]"
+
+
+
+ ],
+
+
+ -
+
+ "image":
+ [
+
+ -
+
+ "[\"users/1232s2133sdd1-12e2dasd3123.png\"]"
+
+
+
+ ],
+
+
+ -
+
+ "userId":
+ "62832531a05cbd57b273aebb",
+
+
+ -
+
+ "mentorName":
+ "jhon",
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "deleted":
+ false,
+
+
+ -
+
+ "startDate":
+ "2022-01-04
+ 18:00:00",
+
+
+ -
+
+ "endDate":
+ "2022-01-04
+ 18:30:00",
+
+
+ -
+
+ "startDateUtc":
+ "Invalid
+ date",
+
+
+ -
+
+ "endDateUtc":
+ "Invalid
+ date",
+
+
+ -
+
+ "skippedFeedback":
+ false,
+
+
+ -
+
+ "menteeFeedbackForm":
+ "menteeQS1",
+
+
+ -
+
+ "mentorFeedbackForm":
+ "mentorQS2",
+
+
+ -
+
+ "recordingUrl":
+ null,
+
+
+ -
+
+ "internalMeetingId":
+ null,
+
+
+ -
+
+ "feedbacks":
+ null,
+
+
+ -
+
+ "updatedAt":
+ "2022-05-25T04:18:23.942Z",
+
+
+ -
+
+ "createdAt":
+ "2022-05-25T04:18:23.942Z",
+
+
+ -
+
+ "__v":
+ 0,
+
+
+ -
+
+ "isEnrolled":
+ false
+
+
+
+ },
+
+
+ -
+
+ "meta":
+ null
+
+
+
+ }
+ This API is associated with enrolling in a session on mentoring
+/mentoring/v1/sessions/enroll
+ required
+ |
+ sessionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 62832531a05cbd57b273aebb
+
+
+
+
+
+ + Please append a valid sessionId To the Request URL + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "You have enrolled
+ successfully.",
+
+
+ -
+
+ "result":
+ [ ],
+
+
+ -
+
+ "meta":
+ null
+
+
+
+ }
+ This API is associated with unenrolling in a session on mentoring
+/mentoring/v1/sessions/unenroll
+ required
+ |
+ sessionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 62832531a05cbd57b273aebb
+
+
+
+
+
+ + Please append a valid sessionId To the Request URL + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "You are no longer enrolled in
+ this session.",
+
+
+ -
+
+ "result":
+ [ ],
+
+
+ -
+
+ "meta":
+ null
+
+
+
+ }
+ This API is associated with starting session on mentoring
+/mentoring/v1/sessions/start
+ required
+ |
+ sessionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 62832531a05cbd57b273aebb
+
+
+
+
+
+ + Please append a valid session id To the Request URL + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Successfully fetched session
+ start link.",
+
+
+ -
+
+
+ -
+
+ "meta":
+ null
+
+
+
+ }
+ This API is associated with creating session on mentoring
+/mentoring/v1/sessions/update
+ required
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
|
+ title
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ description
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ startDate
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ endDate
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+
+ required
+ |
+
+
+
+
+ Array of objects
+
+
+ |
+
|
+
+ required
+ |
+
+
+
+
+ Array of objects
+
+
+ |
+
|
+
+ required
+ |
+
+
+
+
+ Array of objects
+
+
+ |
+
| + image + | +
+
+
+
+ Array of strings
+
+
+ |
+
{
+
+ -
+
+ "title":
+ "testing",
+
+
+ -
+
+ "description":
+ "Training in
+ leadership",
+
+
+ -
+
+ "startDate":
+ "2022-01-04
+ 18:00:00",
+
+
+ -
+
+ "endDate":
+ "2022-01-04
+ 18:30:00",
+
+
+ -
+
+ "recommendedFor":
+ [
+
+ -
+
+ {
+
+ -
+
+ "label":
+ "HM",
+
+
+ -
+
+ "value":
+ 1
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "categories":
+ [
+
+ -
+
+ {
+
+ -
+
+ "label":
+ "label",
+
+
+ -
+
+ "value":
+ "value"
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "medium":
+ [
+
+ -
+
+ {
+
+ -
+
+ "label":
+ "Hindi",
+
+
+ -
+
+ "value":
+ 2
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "image":
+ [
+
+ -
+
+ "users/1232s2133sdd1-12e2dasd3123.png"
+
+
+
+ ]
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Session Created
+ successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "title":
+ "testing",
+
+
+ -
+
+ "description":
+ "Training in
+ leadership",
+
+
+ -
+
+ "startDate":
+ "2022-01-04
+ 18:00:00",
+
+
+ -
+
+ "endDate":
+ "2022-01-04
+ 18:30:00",
+
+
+ -
+
+ "recommendedFor":
+ [
+
+ -
+
+ {
+
+ -
+
+ "label":
+ null,
+
+
+ -
+
+ "value":
+ null
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "categories":
+ [
+
+ -
+
+ {
+
+ -
+
+ "label":
+ null,
+
+
+ -
+
+ "value":
+ null
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "medium":
+ [
+
+ -
+
+ {
+
+ -
+
+ "label":
+ null,
+
+
+ -
+
+ "value":
+ null
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "image":
+ [
+
+ -
+
+ "users/1232s2133sdd1-12e2dasd3123.png"
+
+
+
+ ],
+
+
+ -
+
+ "userId":
+ "62832531a05cbd57b273aebb",
+
+
+ -
+
+ "mentorName":
+ "John",
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "deleted":
+ false,
+
+
+ -
+
+ "startDateUtc":
+ "Invalid
+ date",
+
+
+ -
+
+ "endDateUtc":
+ "Invalid
+ date",
+
+
+ -
+
+ "skippedFeedback":
+ false,
+
+
+ -
+
+ "menteeFeedbackForm":
+ "menteeQS1",
+
+
+ -
+
+ "mentorFeedbackForm":
+ "mentorQS2",
+
+
+ -
+
+ "recordingUrl":
+ null,
+
+
+ -
+
+ "internalMeetingId":
+ null,
+
+
+ -
+
+ "_id":
+ "628ee25e4b9243687f68431d",
+
+
+ -
+
+ "feedbacks":
+ [ ],
+
+
+ -
+
+ "updatedAt":
+ "2022-05-26T02:13:50.472Z",
+
+
+ -
+
+ "createdAt":
+ "2022-05-26T02:13:50.472Z",
+
+
+ -
+
+ "__v":
+ 0
+
+
+
+ }
+
+
+
+ }
+ This API is associated with delete session on mentoring
+/mentoring/v1/sessions/update
+ required
+ |
+ sessionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 62832531a05cbd57b273aebb
+
+
+
+
+
+ + Please append a valid sessionId To the Request URL + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Session deleted. This session
+ is no longer available.",
+
+
+ -
+
+ "result":
+ [ ],
+
+
+ -
+
+ "meta":
+ null
+
+
+
+ }
+ This API is associated with update session on mentoring
+/mentoring/v1/sessions/update
+ required
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
| + title + | +
+
+
+
+ string
+
+
+ |
+
| + description + | +
+
+
+
+ string
+
+
+ |
+
| + startDate + | +
+
+
+
+ string
+
+
+ |
+
| + endDate + | +
+
+
+
+ string
+
+
+ |
+
| + menteeFeedbackForm + | +
+
+
+
+ string
+
+
+ |
+
| + mentorFeedbackForm + | +
+
+
+
+ string
+
+
+ |
+
| + + | +
+
+
+
+ Array of objects
+
+
+ |
+
| + + | +
+
+
+
+ Array of objects
+
+
+ |
+
| + + | +
+
+
+
+ Array of objects
+
+
+ |
+
| + image + | +
+
+
+
+ Array of strings
+
+
+ |
+
{
+
+ -
+
+ "title":
+ "testing",
+
+
+ -
+
+ "description":
+ "Training in
+ leadership",
+
+
+ -
+
+ "startDate":
+ "2022-01-04
+ 18:00:00",
+
+
+ -
+
+ "endDate":
+ "2022-01-04
+ 18:30:00",
+
+
+ -
+
+ "menteeFeedbackForm":
+ "feedback",
+
+
+ -
+
+ "mentorFeedbackForm":
+ "feedback",
+
+
+ -
+
+ "recommendedFor":
+ [
+
+ -
+
+ {
+
+ -
+
+ "label":
+ "HM",
+
+
+ -
+
+ "value":
+ 1
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "categories":
+ [
+
+ -
+
+ {
+
+ -
+
+ "label":
+ "label",
+
+
+ -
+
+ "value":
+ "value"
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "medium":
+ [
+
+ -
+
+ {
+
+ -
+
+ "label":
+ "Hindi",
+
+
+ -
+
+ "value":
+ 2
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "image":
+ [
+
+ -
+
+ "users/1232s2133sdd1-12e2dasd3123.png"
+
+
+
+ ]
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Your session details have
+ been updated.",
+
+
+ -
+
+ "result":
+ [ ],
+
+
+ -
+
+ "meta":
+ null
+
+
+
+ }
+ This API is associated with listing session based on condition mentoring
+/mentoring/v1/mentees/sessions
+ required
+ | + enrolled + | +
+
+
+
+ boolean
+
+
+
+ Example:
+
+ true
+
+
+
+
+
+ enrolled status of mentee |
+
| + page + | +
+
+
+
+ number
+
+
+
+ Example:
+
+ 1
+
+
+
+
+
+ Please add page number + |
+
| + limit + | +
+
+
+
+ number
+
+
+
+ Example:
+
+ 2
+
+
+
+
+
+ number of record to limit + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Session fetched
+ successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "data":
+ [
+
+ -
+
+ {
+
+ -
+
+ "_id":
+ "628dae0fce0ce9359aeb8b23",
+
+
+ -
+
+ "title":
+ "Leadership5",
+
+
+ -
+
+ "description":
+ "Training
+ in
+ leadership",
+
+
+ -
+
+ "image":
+ [
+
+ -
+
+ "[\"users/1232s2133sdd1-12e2dasd3123.png\"]"
+
+
+
+ ],
+
+
+ -
+
+ "mentorName":
+ "Ankit",
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "startDate":
+ "2022-01-04
+ 18:00:00",
+
+
+ -
+
+ "endDate":
+ "2022-01-04
+ 18:30:00",
+
+
+ -
+
+ "endDateUtc":
+ "Invalid
+ date"
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "count":
+ 1
+
+
+
+ }
+
+
+
+ }
+ This API is associated with join session as mentee on mentoring
+/mentoring/v1/mentees/joinSession
+ required
+ |
+ sessionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 62832531a05cbd57b273aebb
+
+
+
+
+
+ + Please append a valid sessionId To the Request URL + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Session fetched
+ successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "data":
+ [
+
+ -
+
+ {
+
+ -
+
+ "_id":
+ "628dae0fce0ce9359aeb8b23",
+
+
+ -
+
+ "title":
+ "Leadership5",
+
+
+ -
+
+ "description":
+ "Training
+ in
+ leadership",
+
+
+ -
+
+ "image":
+ [
+
+ -
+
+ "[\"users/1232s2133sdd1-12e2dasd3123.png\"]"
+
+
+
+ ],
+
+
+ -
+
+ "mentorName":
+ "Ankit",
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "startDate":
+ "2022-01-04
+ 18:00:00",
+
+
+ -
+
+ "endDate":
+ "2022-01-04
+ 18:30:00",
+
+
+ -
+
+ "endDateUtc":
+ "Invalid
+ date"
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "count":
+ 1
+
+
+
+ }
+
+
+
+ }
+ This API is associated with mentee report based on condition on mentoring
+/mentoring/v1/mentees/joinSession
+ required
+ |
+ filterType
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ QUARTERLY
+
+
+
+
+
+
+ Please append a valid filter Type for reports like
+ |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Mentees report fetched
+ successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "totalSessionEnrolled":
+ 1,
+
+
+ -
+
+ "totalsessionsAttended":
+ 1
+
+
+
+ },
+
+
+ -
+
+ "meta":
+ null
+
+
+
+ }
+ This API is associated with list of session on mentoring
+/mentoring/v1/mentees/homeFeed
+ required
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Session fetched
+ successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "allSessions":
+ [ ],
+
+
+ -
+
+ "mySessions":
+ [
+
+ -
+
+ {
+
+ -
+
+ "_id":
+ "628dae0fce0ce9359aeb8b23",
+
+
+ -
+
+ "title":
+ "Leadership5",
+
+
+ -
+
+ "description":
+ "Training
+ in
+ leadership",
+
+
+ -
+
+ "image":
+ [
+
+ -
+
+ "[\"users/1232s2133sdd1-12e2dasd3123.png\"]"
+
+
+
+ ],
+
+
+ -
+
+ "mentorName":
+ "jhon",
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "startDate":
+ "2022-01-04
+ 18:00:00",
+
+
+ -
+
+ "endDate":
+ "2022-01-04
+ 18:30:00",
+
+
+ -
+
+ "endDateUtc":
+ "Invalid
+ date"
+
+
+
+ }
+
+
+
+ ]
+
+
+
+ }
+
+
+
+ }
+ This API is associated with mentor reports on mentoring
+/mentoring/v1/mentors/reports
+ required
+ |
+ filterType
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ QUARTERLY
+
+
+
+
+
+
+ Please append a valid filter Type for reports like
+ |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Mentors report fetched
+ successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "totalSessionEnrolled":
+ 1,
+
+
+ -
+
+ "totalsessionsAttended":
+ 1
+
+
+
+ },
+
+
+ -
+
+ "meta":
+ null
+
+
+
+ }
+ This API is associated with creating questions on mentoring
+/mentoring/v1/questions/create
+ required
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
|
+ question
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ options
+ required
+ |
+
+
+
+
+ Array of strings
+
+
+ |
+
|
+ deleted
+ required
+ |
+
+
+
+
+ boolean
+
+
+ |
+
|
+ value
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
|
+ hint
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
{
+
+ -
+
+ "question":
+ "How much you rate the
+ audio/video quality of
+ session",
+
+
+ -
+
+ "options":
+ [
+
+ -
+
+ [
+
+ -
+
+ "1",
+
+
+ -
+
+ "2"
+
+
+
+ ]
+
+
+
+ ],
+
+
+ -
+
+ "deleted":
+ false,
+
+
+ -
+
+ "value":
+ "1",
+
+
+ -
+
+ "hint":
+ ""
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Question created
+ successfully",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "question":
+ "How much you rate
+ the audio/video quality
+ of session",
+
+
+ -
+
+ "options":
+ null,
+
+
+ -
+
+ "deleted":
+ false,
+
+
+ -
+
+ "validators":
+ {
+
+ -
+
+ "required":
+ false
+
+
+
+ },
+
+
+ -
+
+ "value":
+ "1",
+
+
+ -
+
+ "hint":
+ "",
+
+
+ -
+
+ "disable":
+ false,
+
+
+ -
+
+ "visible":
+ true,
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "_id":
+ "6296e6892fdc1f037cbf4529",
+
+
+ -
+
+ "updatedAt":
+ "2022-06-01T04:09:45.713Z",
+
+
+ -
+
+ "createdAt":
+ "2022-06-01T04:09:45.713Z",
+
+
+ -
+
+ "__v":
+ 0
+
+
+
+ },
+
+
+ -
+
+ "meta":
+ { }
+
+
+
+ }
+ This API is associated with updating questions on mentoring
+/mentoring/v1/questions/update
+ required
+ |
+ QuestionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 629978caf0cf0901d7d74d12
+
+
+
+
+
+ Please append a valid question id in url + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
| + question + | +
+
+
+
+ string
+
+
+ |
+
| + options + | +
+
+
+
+ Array of strings
+
+
+ |
+
| + deleted + | +
+
+
+
+ boolean
+
+
+ |
+
| + value + | +
+
+
+
+ string
+
+
+ |
+
| + hint + | +
+
+
+
+ string
+
+
+ |
+
{
+
+ -
+
+ "question":
+ "How much you rate the
+ audio/video quality of
+ session",
+
+
+ -
+
+ "options":
+ [
+
+ -
+
+ [
+
+ -
+
+ "1",
+
+
+ -
+
+ "2",
+
+
+ -
+
+ "3"
+
+
+
+ ]
+
+
+
+ ],
+
+
+ -
+
+ "deleted":
+ false,
+
+
+ -
+
+ "value":
+ "1",
+
+
+ -
+
+ "hint":
+ ""
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Question updated
+ successfully",
+
+
+ -
+
+ "result":
+ [ ],
+
+
+ -
+
+ "meta":
+ { }
+
+
+
+ }
+ This API is associated with getting questions on mentoring
+/mentoring/v1/questions/readrequired
+ |
+ QuestionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 629978caf0cf0901d7d74d12
+
+
+
+
+
+ Please append a valid question id in url + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Question created
+ successfully",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "question":
+ "How much you rate
+ the audio/video quality
+ of session",
+
+
+ -
+
+ "options":
+ [
+
+ -
+
+ "1",
+
+
+ -
+
+ "2",
+
+
+ -
+
+ "3"
+
+
+
+ ],
+
+
+ -
+
+ "deleted":
+ false,
+
+
+ -
+
+ "validators":
+ {
+
+ -
+
+ "required":
+ false
+
+
+
+ },
+
+
+ -
+
+ "value":
+ "1",
+
+
+ -
+
+ "hint":
+ "",
+
+
+ -
+
+ "disable":
+ false,
+
+
+ -
+
+ "visible":
+ true,
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "_id":
+ "6296e6892fdc1f037cbf4529",
+
+
+ -
+
+ "updatedAt":
+ "2022-06-01T04:09:45.713Z",
+
+
+ -
+
+ "createdAt":
+ "2022-06-01T04:09:45.713Z",
+
+
+ -
+
+ "__v":
+ 0
+
+
+
+ },
+
+
+ -
+
+ "meta":
+ { }
+
+
+
+ }
+ This API is associated with creating questions set on mentoring
+/mentoring/v1/questionsSet/create
+ required
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
|
+
+ required
+ |
+
+
+
+
+ Array of items
+
+
+ |
+
|
+ code
+ required
+ |
+
+
+
+
+ any
+
+
+ |
+
{
+
+ -
+
+ "questions":
+ [
+
+ -
+
+ "6296e6892fdc1f037cbf4529",
+
+
+ -
+
+ "6296e6892fdc1f037cbf4767"
+
+
+
+ ],
+
+
+ -
+
+ "code":
+ null
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Questions set created
+ successfully",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "questions":
+ [
+
+ -
+
+ "6296e6892fdc1f037cbf4529",
+
+
+ -
+
+ "6296e6892fdc1f037cbf4767"
+
+
+
+ ],
+
+
+ -
+
+ "code":
+ "feedback",
+
+
+ -
+
+ "deleted":
+ false,
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "_id":
+ "629978caf0cf0901d7d74d12",
+
+
+ -
+
+ "updatedAt":
+ "2022-06-03T02:58:18.462Z",
+
+
+ -
+
+ "createdAt":
+ "2022-06-03T02:58:18.462Z",
+
+
+ -
+
+ "__v":
+ 0
+
+
+
+ },
+
+
+ -
+
+ "meta":
+ { }
+
+
+
+ }
+ This API is associated with updating questions set on mentoring
+/mentoring/v1/questionsSet/update
+ required
+ |
+ QuestionSetId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 629978caf0cf0901d7d74d12
+
+
+
+
+
+ Please append a valid question set id in url + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
| + + | +
+
+
+
+ Array of items
+
+
+ |
+
| + code + | +
+
+
+
+ any
+
+
+ |
+
{
+
+ -
+
+ "questions":
+ [
+
+ -
+
+ "6296e6892fdc1f037cbf4529",
+
+
+ -
+
+ "6296e6892fdc1f037cbf4767",
+
+
+ -
+
+ "6296e6522fdc1f037cbf4525"
+
+
+
+ ],
+
+
+ -
+
+ "code":
+ null
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Questions set updated
+ successfully",
+
+
+ -
+
+ "result":
+ [ ],
+
+
+ -
+
+ "meta":
+ { }
+
+
+
+ }
+ This API is associated with getting questions set on mentoring
+/mentoring/v1/questionsSet/read
+ required
+ |
+ QuestionSetId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 629978caf0cf0901d7d74d12
+
+
+
+
+
+ Please append a valid question set id in url + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Questions set fetched
+ successfully",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "questions":
+ [
+
+ -
+
+ "6296e6892fdc1f037cbf4529",
+
+
+ -
+
+ "6296e6892fdc1f037cbf4767"
+
+
+
+ ],
+
+
+ -
+
+ "code":
+ "feedback",
+
+
+ -
+
+ "deleted":
+ false,
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "_id":
+ "629978caf0cf0901d7d74d12",
+
+
+ -
+
+ "updatedAt":
+ "2022-06-03T02:58:18.462Z",
+
+
+ -
+
+ "createdAt":
+ "2022-06-03T02:58:18.462Z",
+
+
+ -
+
+ "__v":
+ 0
+
+
+
+ },
+
+
+ -
+
+ "meta":
+ { }
+
+
+
+ }
+ This API is associated with getting feedback forms of the session.
+/mentoring/v1/feedback/forms
+ required
+ |
+ SessionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 629978caf0cf0901d7d74d12
+
+
+
+
+
+ Please append a valid session id in url + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Thank you for hosting the
+ session, please rate us on the
+ following to help us
+ improve.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "form":
+ [
+
+ -
+
+ {
+
+ -
+
+ "_id":
+ "6296e6522fdc1f037cbf4525",
+
+
+ -
+
+ "options":
+ [
+
+ -
+
+ "1",
+
+
+ -
+
+ "2"
+
+
+
+ ],
+
+
+ -
+
+ "deleted":
+ false,
+
+
+ -
+
+ "validators":
+ {
+
+ -
+
+ "required":
+ false
+
+
+
+ },
+
+
+ -
+
+ "value":
+ "",
+
+
+ -
+
+ "hint":
+ "",
+
+
+ -
+
+ "disable":
+ false,
+
+
+ -
+
+ "visible":
+ true,
+
+
+ -
+
+ "status":
+ "published",
+
+
+ -
+
+ "updatedAt":
+ "2022-06-01T04:08:50.155Z",
+
+
+ -
+
+ "createdAt":
+ "2022-06-01T04:08:50.155Z",
+
+
+ -
+
+ "__v":
+ 1,
+
+
+ -
+
+ "questionsSetId":
+ "629978caf0cf0901d7d74d12",
+
+
+ -
+
+ "label":
+ "How
+ much
+ you
+ rate
+ the
+ audio/video
+ quality
+ of
+ session"
+
+
+
+ }
+
+
+
+ ]
+
+
+
+ },
+
+
+ -
+
+ "meta":
+ { }
+
+
+
+ }
+ This API is associated with submit feedback forms of the session.
+/mentoring/v1/feedback/submit
+ required
+ |
+ SessionId
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ 629978caf0cf0901d7d74d12
+
+
+
+
+
+ Please append a valid session id in url + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
|
+
+ required
+ |
+
+
+
+
+ Array of objects
+
+
+ |
+
|
+ feedbackAs
+ required
+ |
+
+
+
+
+ string
+
+
+ |
+
{
+
+ -
+
+ "feedbacks":
+ [
+
+ -
+
+ {
+
+ -
+
+ "questionId":
+ "6296e65c2fdc1f037cbf4527",
+
+
+ -
+
+ "value":
+ "1",
+
+
+ -
+
+ "question":
+ "How
+ much you
+ rate the
+ audio/video
+ quality of
+ session"
+
+
+
+ }
+
+
+
+ ],
+
+
+ -
+
+ "feedbackAs":
+ "mentee"
+
+
+
+ }
+ {
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Feedback submitted
+ successfully.",
+
+
+ -
+
+ "result":
+ [ ],
+
+
+ -
+
+ "meta":
+ { }
+
+
+
+ }
+ This API is associated with fetching users pending feedback form
+/mentoring/v1/users/pendingFeedbacks
+ required
+ |
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK,",
+
+
+ -
+
+ "message":
+ "Pending feedbacks fetched
+ successfully.",
+
+
+ -
+
+ "result":
+ [
+
+ -
+
+ {
+
+ -
+
+ "_id":
+ "628ee0c8efb3923017c27f03",
+
+
+ -
+
+ "title":
+ "Leadership5",
+
+
+ -
+
+ "description":
+ "Training
+ in
+ leadership",
+
+
+ -
+
+ "mentorFeedbackForm":
+ "mentorQS2",
+
+
+ -
+
+ "form":
+ { }
+
+
+
+ }
+
+
+
+ ]
+
+
+
+ }
+ This API is associated with the cloud services for getting signed URL
+/user/v1/cloud-services/file/getSignedUrl
+ required
+ |
+ fileName
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ image.jpg
+
+
+
+
+
+ + Please append a valid file name to url which has to + be uploaded + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Signed Url Generated
+ Successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+
+ -
+
+ "filePath":
+ "users/62832531a05cbd57b273aebb-1654149589875-laptop1.jpg",
+
+
+ -
+
+ "destFilePath":
+ "users/62832531a05cbd57b273aebb-1654149589875-laptop1.jpg"
+
+
+
+ }
+
+
+
+ }
+ + This API is associated with the cloud services for getting downloadable URL +
+
/user/v1/cloud-services/file/getDownloadableUrl
+ required
+ |
+ filePath
+ required
+ |
+
+
+
+
+ string
+
+
+
+ Example:
+
+ users/62832531a05cbd57b273aebb-1654149589875-image.jpg
+
+
+
+
+
+ + Please append a valid file path to url which has to + be downloaded + + |
+
|
+ X-auth-token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require X-auth-token. + This is Available in login API Response. + + |
+
{
+
+ -
+
+ "responseCode":
+ "OK",
+
+
+ -
+
+ "message":
+ "Download Url Generated
+ Successfully.",
+
+
+ -
+
+
+
+ }
+ This API is associated with sending email through API
+
/notification/v1/email/send
+ required
+ |
+ internal_access_token
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ + To make use of the API, you require internal access + token. + + |
+
Request body consist of metadata and accepts payload as JSON
+|
+ type
+ required
+ |
+
+
+
+
+ string
+
+
+
+
+
+ Type of channel eg. email + |
+
|
+
+ required
+ |
+
+
+
+
+ object
+
+
+ |
+
{
+
+ -
+
+ "type":
+ "email",
+
+
+ -
+
+ "email":
+ {
+
+ -
+
+ "to":
+ "example@mail.com",
+
+
+ -
+
+ "cc":
+ "ccexample@mail.com",
+
+
+ -
+
+ "subject":
+ "Email
+ Notification",
+
+
+ -
+
+ "body":
+ "Dear Jhon, \n
+ Welcome to
+ Notification"
+
+
+
+ }
+
+
+
+ }
+ {
+
+ -
+
+ "message":
+ "Email sent
+ successfully.",
+
+
+ -
+
+ "result":
+ {
+
+ -
+
+ "status":
+ "success",
+
+
+ -
+
+ "message":
+ "successfully mail
+ sent"
+
+
+
+ }
+
+
+
+ }
+