Documentation Powered by Redocly

Elevate Mentoring (1.0.0)

Download OpenAPI specification:Download

E-mail: tech-infra@shikshalokam.org License: MIT License
  • The Mentoring Service is a centralized service that supports other services. Application Programming Interfaces (APIs) exposed by the Mentoring Service can be used to perform operations related to other entities such as users, mentors, mentees, and sessions.
  • The URL to access the Mentoring API(s) is {context}/mentoring/v1
    • Note: These resources can be used in other services.

Config

You can use this API to get config related to the service

Get app config

Responses

Response samples

Content type
application/json
Example
{
  • "responseCode": "OK",
  • "message": "App config fetched successfully",
  • "result": {
    },
  • "meta": {
    }
}

Mentee

mentee APIs

Get list of enrolled session

This API is associated with listing session based on condition

  • Endpoint for list session /mentoring/v1/mentees/sessions
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
page
number
Example: 1

Please add page number

limit
number
Example: 2

number of record to limit

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Session fetched successfully.",
  • "result": {
    },
  • "meta": {
    }
}

Join session as mentee

This API is associated with join session as mentee

  • The API Endpoint forjoin session /mentoring/v1/mentees/joinSession
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
sessionId
required
string
Example: 62832531a05cbd57b273aebb

Please append a valid sessionId to the Request URL.

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{}

Mentee reports

This API is associated with mentee report based on condition

  • The API Endpoint formentee report /mentoring/v1/mentees/joinSession
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
filterType
required
string
Example: QUARTERLY

Please append a valid filter type for reports such as MONTHLY or QUARTERLY

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "response_code": "OK",
  • "message": "Mentees report fetched successfully.",
  • "result": {
    },
  • "meta": { }
}

Get list of sessions

This API is associated with list of session

  • The API Endpoint forlist session /mentoring/v1/mentees/homeFeed
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "response_code": "OK",
  • "message": "Session fetched successfully.",
  • "result": {},
  • "meta": {
    }
}

Mentor

Mentor

Mentor profile

This API is associated with mentor profile

  • Endpoint for list session /mentoring/v1/mentors/profile
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
mentorId
required
string
Example: 62a820225ff93f30cfe5f990

Please append a valid mentorId

header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application.json
{
  • "response_code": "OK",
  • "message": "Profile fetched successfully.",
  • "result": {
    },
  • "meta": {
    }
}

Mentors reports

This API is associated with mentor reports

  • The API Endpoint forlist session /mentoring/v1/mentors/reports
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
filterType
required
string
Example: QUARTERLY

Please append a valid filter Type for reports like MONTHLY or QUARTERLY

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "response_code": "OK",
  • "message": "Mentors report fetched successfully.",
  • "result": {
    },
  • "meta": {
    }
}

Upcoming sessions of mentor

This API is associated with the listing of upcoming sessions of one mentor

  • Endpoint for listing session /mentoring/v1/mentors/upcomingSessions/
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
mentorId
required
string
Example: 62a820225ff93f30cfe5f990

Please append a valid mentorId

page
number
Example: 1

Please add page number

limit
number
Example: 2

number of record to limit

search
string
Example: jhon

Please search for author name or title of session etc.

header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application.json
{
  • "response_code": "OK",
  • "message": "Upcoming session fetched successfully.",
  • "result": [
    ],
  • "meta": {
    }
}

Share mentor profile

This API is associated with mentor profile

  • Endpoint for share mentor profile is /mentoring/v1/mentors/share
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
mentorId
required
string
Example: 21

Please append a valid mentorId

header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application.json
{
  • "response_code": "OK",
  • "message": "Profile share link generated successfully",
  • "result": {
    },
  • "meta": {
    }
}

Get all the available mentor

This API is associated with mentor profile

  • Endpoint for listing all mentor is /mentoring/v1/mentors/list
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
area_of_expertise
string

Filters to be applied should be passed like this

mentorId
required
string
Example: 21

Please append a valid mentorId

header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "User list fetched successfully.",
  • "result": {
    },
  • "meta": {
    }
}

Get all the available mentor

This API is associated with mentor profile

  • Endpoint for listing all sessions created by mentor is /mentoring/v1/mentors/createdSessions
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
status
required
string
Example: 21

Values in:PUBLISHED,COMPLETED and LIVE

header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Session fetched successfully.",
  • "result": {
    },
  • "meta": {
    }
}

Entity Type

Create entity type

You can use this API to create a user entity

  • The API Endpoint for creating a user entity is /mentoring/v1/entity-type/create
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
string
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application.json

Example 1 is for creating user entity types and Example 2 is for creating session enitity types

value
string
label
string
allow_filtering
string
data_type
string
model_names
Array of strings
required
boolean
status
string
type
string

Responses

Request samples

Content type
application.json
Example
{
  • "value": "pgender",
  • "label": "gender",
  • "allow_filtering": "true",
  • "data_type": "ARRAY[STRING]",
  • "model_names": [
    ],
  • "required": true,
  • "status": "ACTIVE",
  • "type": "SYSTEM"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity type created successfully",
  • "result": {
    },
  • "meta": {
    }
}

Read entity type

You can use this API to create a user entity

  • The API Endpoint for creating a user entity is /mentoring/v1/entity-type/read
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ],
  • "read_user_entity": false
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity type fetched successfully",
  • "result": [
    ],
  • "meta": {
    }
}

Update entity type

You can use this API to create a user entity

  • The API Endpoint for creating a user entity is /mentoring/v1/entity-type/update
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json

Example 1 is for updating user entity types and Example 2 is for updating session enitity types

value
string
label
string
status
string
type
string
data_type
string
model_names
Array of strings
allow_filtering
boolean
required
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "value": "QATESTING",
  • "label": "QATESTING",
  • "status": "ACTIVE",
  • "type": "SYSTEM",
  • "data_type": "ARRAY[STRING]",
  • "model_names": [
    ],
  • "allow_filtering": true,
  • "required": true
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity type updated successfully",
  • "result": {
    },
  • "meta": {
    }
}

Delete entity type

You can use this API to create a user entity

  • The API Endpoint for creating a user entity is /mentoring/v1/entity-type/delete
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity type deleted successfully",
  • "result": [ ],
  • "meta": {
    }
}

Profile

Create details

This API is associated with the profile API

  • Endpoint for listing session /mentoring/v1/profile/create/
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Request Body schema: application/json
designation
string
area_of_expertise
Array of strings
education_qualification
Array of strings
experience
string
object
tags
Array of strings
object
visibility
string
organisation_ids
Array of numbers
external_session_visibility
string
external_mentor_visibility
string

Responses

Request samples

Content type
application/json
{
  • "designation": "Lead Mentor",
  • "area_of_expertise": [
    ],
  • "education_qualification": [
    ],
  • "experience": "10 years",
  • "tags": [
    ],
  • "configs": {
    }
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Mentee extension created successfully.",
  • "result": {
    },
  • "meta": {
    }
}

Update details

This API is associated with profile

  • Endpoint for listing session /mentoring/v1/profile/update
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Request Body schema: application/json
designation
string
area_of_expertise
Array of strings
education_qualification
Array of strings
experience
string
tags
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "designation": "Lead Mentor",
  • "area_of_expertise": [
    ],
  • "education_qualification": [
    ],
  • "experience": "10 years",
  • "tags": [
    ],
  • "configs": {
    }
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Mentee extension updated successfully.",
  • "result": {
    },
  • "meta": {
    }
}

Get entity type and organization filter

To obtain the list of filters used in the mentee/mentor list, use this API.

  • The API Endpoint for get the filter is /mentoring/v1/profile/filterList
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
entity_types
string
Example: designation

Please add the entity type. example designation

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Filter list fetched successfully.",
  • "result": {
    }
}

Organization Admin

To change a users role

You can use this API to create a user entity

  • The API Endpoint for changing a users role is /mentoring/v1/org-admin/roleChange
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json
user_id
string
current_roles
Array of strings
new_roles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "user_id": "2",
  • "current_roles": [
    ],
  • "new_roles": [
    ]
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "User role was updated, please login again.",
  • "result": {
    },
  • "meta": {
    }
}

To inherit an entity type

You can use this API to create a user entity

  • The API Endpoint for inheriting an entity type is /mentoring/v1/org-admin/inheritEntityType
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json
entity_type_value
string
target_entity_type_label
string

Responses

Request samples

Content type
application/json
{
  • "entity_type_value": "categories",
  • "target_entity_type_label": "training"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity type created successfully",
  • "result": {
    },
  • "meta": {
    }
}

To get current organization policy

You can use this API to create a user entity

  • The API Endpoint for getting organization policy is /mentoring/v1/org-admin/getOrgPolicies
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "ORG_POLICIES_FETCHED_SUCCESSFULLY",
  • "result": {
    },
  • "meta": {
    }
}

To set related organizations

You can use this API to create a user entity

  • The API Endpoint for setting related organization policy is /mentoring/v1/org-admin/updateRelatedOrgs
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json
responseCode
string
message
string
result
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Related organizations updated successfully",
  • "result": [ ],
  • "meta": {
    }
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "ORG_POLICIES_FETCHED_SUCCESSFULLY",
  • "result": {
    },
  • "meta": {
    }
}

To set organization policy

You can use this API to create a user entity

  • The API Endpoint for setting organization policy is /mentoring/v1/org-admin/setOrgPoliciessetOrgPolicies
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json
session_visibility_policy
string
mentor_visibility_policy
string
external_session_visibility_policy
string
external_mentor_visibility_policy
string
allow_mentor_override
boolean

Responses

Request samples

Content type
application/json
{
  • "session_visibility_policy": "ALL",
  • "mentor_visibility_policy": "ALL",
  • "external_session_visibility_policy": "ALL",
  • "external_mentor_visibility_policy": "ALL",
  • "allow_mentor_override": false
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "ORG_POLICIES_SET_SUCCESSFULLY",
  • "result": {
    },
  • "meta": {
    }
}

Upload Sample CSV

You can use this API to create a session

  • The API Endpoint for updating a Sample CSV is: /mentoring/v1/org-admin/uploadSampleCSV
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Request Body schema: application.json
string

File path should be attached

Responses

Request samples

Content type
application.json
{
  • "file_path": "session/33-1715667059999-BulkSessionNegativeCheck.csv"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "CSV_UPLOADED_SUCCESSFULLY",
  • "result": [ ],
  • "meta": {
    }
}

Admin

To delete a user

You can use this API to create a user entity

  • The API Endpoint for deleting a user is /mentoring/v1/admin/userDelete
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
userId
required
number

ID of the user that needs to be deleted

string
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "User details removed successfully.",
  • "result": {
    },
  • "meta": {
    }
}

To build or rebuild materialized views

You can use this API to create a user entity

  • The API Endpoint for creating view is /mentoring/v1/admin/triggerViewRebuild
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
string
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Materialized views generated successfully",
  • "result": [ ],
  • "meta": {
    }
}

To build or rebuild materialized views, this is supposed to be called internally.

You can use this API to create a user entity

  • The API Endpoint for creating view is /mentoring/v1/admin/triggerViewRebuildInternal
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
string
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Materialized views generated successfully",
  • "result": [ ],
  • "meta": {
    }
}

To refresh all the views data generated via build API.

You can use this API to create a user entity

  • The API Endpoint for refreshing view is /mentoring/v1/admin/triggerPeriodicViewRefresh
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
string
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Materialized views refresh initiated successfully",
  • "result": [ ],
  • "meta": {
    }
}

To refresh a single view, this is supposed to be called internally

You can use this API to create a user entity

  • The API Endpoint for refreshing view is /mentoring/v1/admin/triggerPeriodicViewRefreshInternal
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
model_name
required
string

Model name of the views table

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Materialized views refresh initiated successfully",
  • "result": [ ],
  • "meta": {
    }
}

Permissions

Creating new permissions for userRoles

This API is associated with userPermissionRoles

  • Endpoint for creating permissions /mentoring/v1/permissions/create
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Request Body schema: application/json
code
required
string

Must be unique

module
required
string

module name

request_type
required
Array of strings

request types of the api

api_path
required
string

Url of the api

status
string

Status of that permission

Responses

Request samples

Content type
application/json
{
  • "code": "ssss",
  • "module": "ssss",
  • "request_type": [
    ],
  • "api_path": "/mentoring/v1/sessions/sections",
  • "status": "ACTIVE"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Permission created successfully",
  • "result": {
    },
  • "meta": {
    }
}

Update permissions by id

You can use this API to update permissions

  • The API Endpoint for updating permissions is /mentoring/v1/permissions/update
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json
code
string

code of the permission

module
string

module of the permission

request_type
Array of strings

request type of the api

api_path
string

Url of the api

status
string

status of the permission

Responses

Request samples

Content type
application/json
{
  • "code": "session_creation",
  • "module": "sessions",
  • "actions": "WRITE",
  • "status": "ACTIVE"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Permission updated successfully",
  • "result": {
    },
  • "meta": {
    }
}

Delete permissions by id

You can use this API to delete permission

  • The API Endpoint for deleting permissions is /mentoring/v1/permissions/delete
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Permission deleted successfully",
  • "result": { },
  • "meta": {
    }
}

Get list of permissions

You can use this API to get a list of permissions

  • The API Endpoint for getting a list of permissions is /mentoring/v1/permissions/list
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
page
number
Example: 1

Please add page number

limit
number
Example: 2

Number of records to limit

search
string
Example: John

Please search for information such as 'code' names

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Permissions fetched successfully",
  • "result": {
    },
  • "meta": {
    }
}

Modules

Creating new modules

This API is associated with modules

  • Endpoint for creating modules /mentoring/v1/modules/create
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Request Body schema: application/json
code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "system_admin"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Module created successfully",
  • "result": {
    },
  • "meta": {
    }
}

Update modules by id

You can use this API to update modules by id

  • The API Endpoint for updating modules /mentoring/v1/modules/update
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json
code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "session_creation",
  • "module": "sessions",
  • "actions": "WRITE",
  • "status": "ACTIVE"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Module updated successfully",
  • "result": {
    },
  • "meta": {
    }
}

Delete modules by id

You can use this API to delete modules

  • The API Endpoint for deleting modules is /mentoring/v1/modules/delete
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Module deleted successfully",
  • "result": { },
  • "meta": {
    }
}

Get list of modules

You can use this API to get a list of modules

  • The API Endpoint for getting a list of modules is /mentoring/v1/modules/list
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
page
number
Example: 1

Please add page number

limit
number
Example: 2

Number of records to limit

search
string
Example: John

Please search for information such as 'code' names

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Module fetched successfully",
  • "result": {
    },
  • "meta": {
    }
}

RolePermissionMapping

Creating new role permission mapping

This API is associated with Role Permissions

  • Endpoint for creating Role Permissions /mentoring/v1/rolePermissionMapping/create
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Request Body schema: application/json
permission_id
required
number

Responses

Request samples

Content type
application/json
{
  • "permission_id": 1
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Permission added to the role",
  • "result": {
    },
  • "meta": {
    }
}

Delete rolePermissionMapping by id

You can use this API to delete Role Permissions

  • The API Endpoint for deleting Role Permissions is /mentoring/v1/rolePermissionMapping/delete
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json
permission_id
required
number

Responses

Request samples

Content type
application/json
{
  • "permission_id": 1
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "ROLE_PERMISSION_MAPPING_DELETED_SUCCESSFULLY",
  • "result": { },
  • "meta": {
    }
}

Default-Rules

Api's for setting default rules for search

Create default rule

You can use this API to create a default rule

  • The API Endpoint for creating a default rule is /mentoring/v1/default-rule/create
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
string
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application.json
type
required
string
Enum: "mentor" "session"
target_field
required
string

One of the valid entity types, which will be matched against the details of the session or the session's mentor.

is_target_from_sessions_mentor
required
boolean

Specifies whether the target field is in the session or mentor details.

requester_field
required
string

One of the valid entity types, which will be matched against the requesting user's profile details.

operator
required
string
Enum: "equals" "notEquals" "contains" "containedBy" "overlap" "lessThan" "greaterThan" "lessThanOrEqual" "greaterThanOrEqual"
requester_roles
Array of strings non-empty
Default: ["ALL"]
object
Default: {"exclude":false}

Responses

Request samples

Content type
application.json
Example
{
  • "type": "session",
  • "target_field": "gender",
  • "is_target_from_sessions_mentor": true,
  • "requester_field": "gender",
  • "operator": "equals",
  • "requester_roles": [
    ],
  • "requester_roles_config": {
    }
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "The default rule has been created successfully.",
  • "result": {
    },
  • "meta": {
    }
}

Read default rules

You can use this API to read default rules

  • The API Endpoint for reading the default rules is /mentoring/v1/default-rule/read
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
id
number

To get a specific rule

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
{
  • "responseCode": "OK",
  • "message": "The default rule has been fetched successfully.",
  • "result": {
    },
  • "meta": {
    }
}

Update default rule

You can use this API to update a default rule

  • The API Endpoint for updating the default rules is /mentoring/v1/default-rule/update
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
query Parameters
id
required
integer

default rules id

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application/json
type
string
Enum: "mentor" "session"
target_field
string

One of the valid entity types, which will be matched against the details of the session or the session's mentor.

is_target_from_sessions_mentor
boolean
Default: false

Specifies whether the target field is in the session or mentor details.

requester_field
string

One of the valid entity types, which will be matched against the requesting user's profile details.

operator
string
Enum: "equals" "notEquals" "contains" "containedBy" "overlap" "lessThan" "greaterThan" "lessThanOrEqual" "greaterThanOrEqual"
requester_roles
Array of strings non-empty
Default: ["ALL"]
object
Default: {"exclude":false}

Responses

Request samples

Content type
application/json
{
  • "type": "session",
  • "target_field": "gender",
  • "is_target_from_sessions_mentor": true,
  • "requester_field": "gender",
  • "operator": "equals",
  • "requester_roles": [
    ],
  • "requester_roles_config": {
    }
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "The default rule has been updated successfully.",
  • "result": [
    ],
  • "meta": {
    }
}

Delete default rule

You can use this API to delete default rules

  • The API Endpoint for creating a user entity is /mentoring/v1/default-rule/delete
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null.
query Parameters
id
required
integer
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "The default rule has been deleted successfully.",
  • "result": [ ],
  • "meta": {
    }
}

Session

Get list of sessions

You can use this API to get a list of session based on certain conditions

  • The API Endpoint for getting a list of sessions is /mentoring/v1/sessions/list
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
page
number
Example: 1

Please add page number

limit
number
Example: 2

Number of records to limit

status
string
Example: PUBLISHED, COMPLETED

Please append a status. For example, for published user append the value PUBLISHED and for completed user, append the value COMPLETED.

search
string
Example: John

Please search for information such as author name or title of session.

recommended_for
string

Filters to be applied should be passed like this

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Session fetched successfully.",
  • "result": {}
}

Get session details

You can use this API to get details of the session

  • The API Endpoint for getting the details of the session is /mentoring/v1/sessions/details
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
path Parameters
sessionId
required
string
Example: 1

Please append a valid sessionId to the Request URL.

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Session fetched successfully.",
  • "result": {
    },
  • "meta": { }
}

Share session details

You can use this API to share session

  • The API Endpoint for sharing a session is: /mentoring/v1/sessions/share
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
path Parameters
sessionId
required
string
Example: 1

Please append a valid sessionId to the Request URL..

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Session link generated successfully.",
  • "result": {
    },
  • "meta": { }
}

Enroll for a session

You can use this API to enroll for a session

  • The API Endpoint to enroll for a session is: /mentoring/v1/sessions/enroll
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
path Parameters
sessionId
required
string
Example: 1

Please append a valid sessionId to the Request URL..

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API., which is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "You have successfully enrolled for this session.",
  • "result": [ ],
  • "meta": null
}

Cancel enrollment from a session

You can use this API to cancel the enrollment for a session

  • The API Endpoint for cancelling enrollment for a session is /mentoring/v1/sessions/unenroll
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
path Parameters
sessionId
required
string
Example: 1

Please append a valid sessionId to the Request URL.

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "You are no longer enrolled in this session.",
  • "result": [ ],
  • "meta": null
}

Start Session

You can use this API to start a session

  • The API Endpoint for starting a session is: /mentoring/v1/sessions/start
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
path Parameters
sessionId
required
string
Example: 1

Please append a valid session id to the Request URL.

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{}

Create Session

You can use this API to create a session

  • The API Endpoint for creating a session is: /mentoring/v1/sessions/update
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Request Body schema: application.json
title
string
description
string
start_date
string
end_date
string
mentee_feedback_question_set
string
mentor_feedback_question_set
string
recommended_for
Array of strings
categories
Array of strings
medium
Array of strings
image
Array of strings

Responses

Request samples

Content type
application.json
{
  • "title": "Leadership session by Adam",
  • "description": "Leadership session desc",
  • "start_date": "1695210731",
  • "end_date": "1695214329",
  • "mentee_feedback_question_set": "MENTEE_QS1",
  • "mentor_feedback_question_set": "MENTOR_QS2",
  • "recommended_for": [
    ],
  • "categories": [
    ],
  • "medium": [
    ],
  • "image": [
    ]
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Session created successfully.",
  • "result": {
    }
}

Delete session

You can use this API to delete a session

  • The API Endpoint for deleting a session is: /mentoring/v1/sessions/update
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
path Parameters
sessionId
required
string
Example: 1

Please append a valid sessionId to the Request URL.

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Session successfully deleted. This session is no longer available.",
  • "result": [ ],
  • "meta": { }
}

Update session

You can use this API to update a session

  • The API Endpoint for updating a session /mentoring/v1/sessions/update
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Request Body schema: application.json
title
string
description
string
start_date
string
end_date
string
mentee_feedback_question_set
string
mentor_feedback_question_set
string
recommended_for
Array of strings
categories
Array of strings
medium
Array of strings
image
Array of strings

Responses

Request samples

Content type
application.json
{
  • "title": "Leadership session by Adam",
  • "description": "Leadership session desc",
  • "start_date": "1695210731",
  • "end_date": "1695214329",
  • "mentee_feedback_question_set": "MENTEE_QS1",
  • "mentor_feedback_question_set": "MENTOR_QS2",
  • "recommended_for": [
    ],
  • "categories": [
    ],
  • "medium": [
    ],
  • "image": [
    ]
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Session updated successfully.",
  • "result": {
    }
}

Get session recording

You can use this API to get the recording of a session

  • The API Endpoint to get the recording of a session is: /mentoring/v1/sessions/getRecording
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
path Parameters
sessionId
required
string
Example: 1

Please append a valid sessionId to the Request URL.

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{}

Update session status

You can use this API to update session status

  • Endpoint for update session /mentoring/v1/sessions/completed
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
sessionId
required
string
Example: 1

Please append a valid sessionId to the Request URL.

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "result": "SESSION_UPDATED"
}

Update session recording url

You can use this API to update session recording url

  • Endpoint for update session recording url /mentoring/v1/sessions/updateRecordingUrl
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
internalSessionId
required
string
Example: 1

Please append a valid internalSessionId To the Request URL

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "message": "Your session details have been updated.",
  • "result": { }
}

Get Sample CSV

You can use this API to create a session

  • The API Endpoint for get a Sample CSV is: /mentoring/v1/sessions/getSampleCSV
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{}

Bulk Session Upload

You can use this API to create a session

  • The API Endpoint for creating bulk sessions is: /mentoring/v1/sessions/bulkSessionCreate
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null.
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
{
  • "file_path": "session/33-1715794478895-BulkCsvDevcheck4.csv"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "SESSION_CSV_UPLOADED",
  • "result": {
    },
  • "meta": {
    }
}

Form

Create form

You can use this API to create a form

  • The API Endpoint for creating a form is /mentoring/v1/form/create
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This token is available in the login API Response.

Request Body schema: application.json
type
string
sub_type
string
object

Responses

Request samples

Content type
application.json
{
  • "type": "session",
  • "sub_type": "createSessions",
  • "data": {
    }
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Form created successfully",
  • "result": {
    },
  • "meta": {
    }
}

Update form

You can use this API to update a form.

  • The API Endpoint for updating a form is /mentoring/v1/form/update/{formId}
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
formId
required
number

Please append a valid form Id to the Request URL.

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This token is available in the login API Response.

Request Body schema: application.json
type
string
sub_type
string
object

Responses

Request samples

Content type
application.json
{
  • "type": "session",
  • "sub_type": "createSessionsNew",
  • "data": {
    }
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Form updated successfully",
  • "result": [ ],
  • "meta": {
    }
}

Get form data

You can use this API to read data from a form.

  • The API Endpoint to read form data is /mentoring/v1/form/read/{formID}
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
formId
number

Please append a valid form Id to the Request URL.

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This token is available in the login API Response.

Request Body schema: application.json
type
string
sub_type
string

Responses

Request samples

Content type
application.json
{
  • "type": "session",
  • "sub_type": "createSessionsNew"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Form created successfully",
  • "result": {
    },
  • "meta": {
    }
}

Entity

Create entity

You can use this API to create a user entity

  • The API Endpoint for creating a user entity is /mentoring/v1/entity/create
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
string
header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This is available in the login API Response.

Request Body schema: application.json
value
string
label
string
entity_type_id
number

Responses

Request samples

Content type
application.json
{
  • "value": "en",
  • "label": "English",
  • "entity_type_id": 1
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity created successfully",
  • "result": {
    },
  • "meta": {
    }
}

Update entity

Use this API to update a user entity.

  • The API Endpoint to update a user entity is /mentoring/v1/entity/update
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
id
required
number

Please append a valid user entity ID to the Request URL.

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token, which is available in the login API response.

Request Body schema: application.json
value
string
label
string
status
string
entity_type_id
number

Responses

Request samples

Content type
application.json
{
  • "value": "english",
  • "label": "English",
  • "status": "ACTIVE",
  • "entity_type_id": 1
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity updated successfully",
  • "result": {
    },
  • "meta": {
    }
}

Get entity details

Use this API to read the details of a user entity.

  • The API Endpoint for reading the details of the user entity is /mentoring/v1/entity/read
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
id
string

ID of the entity

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token, which is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity fetched successfully",
  • "result": [
    ],
  • "meta": {
    }
}

Delete entity

You can use this API to delete a user entity.

  • The API Endpoint for deleting a user entity is /mentoring/v1/entity/delete
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null
path Parameters
id
required
string
Example: 62832531a05cbd57b273aebb

Please append a valid user entity ID to the Request URL.

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity deleted successfully",
  • "result": [ ],
  • "meta": {
    }
}

Question

Create questions

This API is associated with creating questions

  • The API Endpoint forcreate question /mentoring/v1/questions/create
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Request Body schema: application.json
name
string

Name of the question

question
string

What question you want to add

type
string

Give the type of the question like feedback or rating

options
null
no_of_stars
number

Number of stars to be set

status
string

Status of the question

category
null

default is null and for mentor we can use evaluating : mentor

object

Setting validations and rules to show the data

meta
null

Responses

Request samples

Content type
application.json
Example
{
  • "name": "keyvalue",
  • "question": "To what extent did you feel comfortable sharing your thoughts in the session?",
  • "type": "rating",
  • "options": null,
  • "no_of_stars": 5,
  • "status": "active",
  • "category": null,
  • "rendering_data": {
    },
  • "meta": null
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Question created successfully",
  • "result": {
    },
  • "meta": {
    }
}

Update questions

This API is associated with updating questions

  • The API Endpoint forupdate question /mentoring/v1/questions/update
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
QuestionId
required
number
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Request Body schema: application.json
name
string

Name of the question

question
string

What question you want to add

type
string

Give the type of the question like feedback or rating

options
null
no_of_stars
number

Number of stars to be set

status
string

Status of the question

object

default category should be as null

object

Setting validations and rules to show the data

Responses

Request samples

Content type
application.json
Example
{
  • "name": "keyvalue",
  • "question": "To what extent were you able to learn new skills in the session Org?",
  • "type": "rating",
  • "options": null,
  • "no_of_stars": 5,
  • "status": "active",
  • "category": {
    },
  • "rendering_data": {
    }
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Question updated successfully",
  • "result": {
    },
  • "meta": {
    }
}

Get questions

This API is associated with getting questions

  • The API Endpoint forget question /mentoring/v1/questions/read
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
QuestionId
required
number

Please append a valid question id in url

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Question fetched successfully",
  • "result": {
    },
  • "meta": {
    }
}

Question Set

Create question set

This API is associated with creating questions set

  • The API Endpoint forcreate question set /mentoring/v1/question-set/create
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Request Body schema: application.json
questions
Array of numbers
code
string

Responses

Request samples

Content type
application.json
{
  • "questions": [
    ],
  • "code": "feedback"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Questions set created successfully",
  • "result": {
    },
  • "meta": {
    }
}

Update question set

This API is associated with updating questions set

  • The API Endpoint forupdating question set /mentoring/v1/question-set/update
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
QuestionSetId
required
number
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Request Body schema: application.json
questions
Array of numbers
code
string

Responses

Request samples

Content type
application.json
{
  • "questions": [
    ],
  • "code": "UpdatedFeedbackCode"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Questions set updated successfully",
  • "result": {
    },
  • "meta": {
    }
}

Get question set

This API is associated with getting questions set

  • The API Endpoint forget question set /mentoring/v1/question-set/read
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
QuestionSetId
required
number
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Question set fetched successfully",
  • "result": {
    },
  • "meta": {
    }
}

Feedback Form

Get feedback form

This API is associated with getting feedback forms of the session.

  • The API Endpoint forget feedback form /mentoring/v1/feedback/forms
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
SessionId
required
string
Example: 1

Please append a valid session id in url

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Thank you for hosting the session. Please rate us on the following to help us improve.",
  • "result": {
    },
  • "meta": { }
}

Submit feedback

This API is associated with submitting feedback forms of a session.

  • The API Endpoint forsubmit feedback form /mentoring/v1/feedback/submit
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
SessionId
required
string
Example: 1

Please append a valid session id in url

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Request Body schema: application.json
Array of objects
feedback_as
string

Responses

Request samples

Content type
application.json
{
  • "feedbacks": [
    ],
  • "feedback_as": "mentee"
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Feedback submitted successfully.",
  • "result": [ ],
  • "meta": { }
}

Users

Users pending feedback

This API is associated with fetching users pending feedback form

  • The API Endpoint forfetching feedback form /mentoring/v1/users/pendingFeedbacks
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK,",
  • "message": "Pending feedbacks fetched successfully.",
  • "result": [
    ]
}

List user

This API is associated with the listing of users based on condition

  • The API Endpoint forlist user /mentoring/v1/users/list
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
userType
required
string
Example: mentor

Type of user

page
number
Example: 1

Please add page number

limit
number
Example: 2

number of record to limit

search
string
Example: jhon

Please search for name or title of user etc.

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{}

Cloud Services

Cloud services get signed url

This API is associated with the cloud services for getting signed URL

  • Then The API Endpoint for cloud services /mentoring/v1/cloud-services/file/getSignedUrl
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
fileName
required
string
Example: image.jpg

Please append a valid file name to url which has to be uploaded

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{}

Cloud services get download url

This API is associated with the cloud services for getting downloadable URL

  • Then The API Endpoint for cloud services /mentoring/v1/cloud-services/file/getDownloadableUrl
  • It is mandatory to provide values for parameters marked with required
  • Mandatory parameter cannot be empty or null
path Parameters
filePath
required
string
Example: users/62832531a05cbd57b273aebb-1654149589875-image.jpg

Please append a valid file path to url which has to be downloaded

header Parameters
x-auth-token
required
string

You require an x-auth-token to use this API. This token is available in the login API Response.

Responses

Response samples

Content type
application.json
{}

Issues

Report an issue

This Api is associated with reporting issues

  • The Endpoint for creating an issue is /mentoring/v1/issues/create
  • It is mandatory to provide values for parameter marked with required
  • Mandatory parameter cannot be empty or null
header Parameters
x-auth-token
required
string

To make use of the API, you require x-auth-token. This is Available in login API Response.

Request Body schema: application.json
descriptaion
string
object

Responses

Request samples

Content type
application.json
{
  • "descriptaion": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. In hendrerit gravida rutrum quisque non tellus. Faucibus interdum posuere lorem ipsum dolor sit amet consectetur adipiscing. Accumsan sit amet nulla facilisi morbi tempus iaculis. Lobortis scelerisque fermentum dui faucibus in.",
  • "meta_data": {
    }
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Your issue is successfully reported.",
  • "result": [ ],
  • "meta": {
    }
}

Entity APIs

Get entity list with pagination and search

Use this API to get the list of a mentoring entities.

  • The API Endpoint for reading the list of the mentoring entities is /mentoring/v1/entity/list
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
page
number
Example: 1

Please add page number

limit
number
Example: 10

Number of records to limit

search
string
Example: teacher

search text

entity_type_id
required
number
Example: teacher

entity_type_id

header Parameters
x-auth-token
required
string

To use this API, you require an x-auth-token, which is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity fetched successfully",
  • "result": {
    },
  • "meta": {
    },
  • "parameters": [ ]
}