Query

Create Query - Eligible Course List

Use this API to fetch the list of courses where Trainee is elegilble to create a query.

 GET /query/trainee-course-list

Query string parameters

Field	Type	Description
firstRecord required	integer	First record to return. Default: 1
count required	integer	Number of records to be returned from the first record Default: 20, Max count limit: 50
q	string	filter data by course title and code

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "courseList": [
                    {
                        "enrollmentId": 706916,
                        "courseId": 99,
                        "title": "B2B Sales Management",
                        "courseCode": "1114",
                        "trainer": "Grant Cardone",
                        "allowToCreate": true
                    }
                ],
                "totalRecords": 6
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
courseList	array	Array of course objects.
enrollmentId	number	ID of the enrollment.
courseId	number	ID of the course.
title	string	Title of the course.
courseCode	string	Code of the course.
trainer	string	Trainer's name for the course.
allowToCreate	boolean	Indicates if the user is allowed to create the course.
totalRecords	number	Total number of records in the response.

Error Codes

For general error details, click here.

Query List for specific Course

Use this API to fetch the list of queries for a Trainee for a specific course.

 GET /query/trainee-query-list

Query string parameters

Field	Type	Description
firstRecord required	integer	First record to return. Default: 1
count required	integer	Number of records to be returned from the first record Default: 20, Max count limit: 100
courseId required	interger	The course ID

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "queryList": [
                    {
                        "queryId": 4404,
                        "title": "John Doe",
                        "ticketNo": "F1693394958",
                        "isViewed": true,
                        "updatedDate": "2023-08-30 16:59:18",
                        "isReplied": false
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
queryList	array	Array of query objects.
queryId	number	ID of the query.
title	string	Title of the query.
ticketNo	string	Ticket number associated with the query.
isViewed	boolean	Indicates if the query has been viewed.
updatedDate	string	Date and time when the query was last updated.
isReplied	boolean	Indicates if the query has been replied to.
totalRecords	number	Total number of records in the response.

Error Codes

Code	Description
1005	"Missing courseId"
1006	"Invalid courseId"

For general error details, click here.

List all Queries

Use this API to list all queries.

 GET /query/trainee-all-query-list

Query string parameters

Field	Type	Description
firstRecord required	integer	First record to return. Default: 1
count required	integer	Number of records to be returned from the first record Default: 20, Max count limit: 100
type required	integer	1-pending, 2-replied
q	string	filter data by ticketNo

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "queryList": [
                    {
                        "queryId": 4404,
                        "title": "John Doe",
                        "ticketNo": "F1693394958",
                        "isViewed": true,
                        "updatedDate": "2023-08-30 16:59:18",
                        "isReplied": false,
                        "courseId": 99,
                        "courseTitle": "B2B Sales Management",
                        "courseCode": "1114"
                    }
                ],
                "totalRecords": 2
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
queryList	array	Array of query objects.
queryId	number	ID of the query.
title	string	Title of the query.
ticketNo	string	Ticket number associated with the query.
isViewed	boolean	Indicates if the query has been viewed.
updatedDate	string	Date and time when the query was last updated.
isReplied	boolean	Indicates if the query has been replied to.
courseId	number	ID of the associated course.
courseTitle	string	Title of the associated course.
courseCode	string	Code of the associated course.
totalRecords	number	Total number of records in the response.

Error Codes

Code	Description
1016	"Missing type"
1017	"Invalid type"

For general error details, click here.

Get Query Details

Use this API to get details of a query.

 GET /query/{queryId}/trainee-query-detail

Path parameters

Field	Type	Description
queryId required	integer	The query ID

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "query": {
                    "ticketNo": "F1693394958",
                    "title": "John Doe",
                    "body": "This is a query regarding my assessment.",
                    "createdDate": "2023-08-30 16:59:18",
                    "attachment": null
                },
                "reply": null
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
query	object	Contains query details.
ticketNo	string	Ticket number associated with the query.
title	string	Title of the query.
body	string	Body of the query.
createdDate	string	Date and time when the query was created.
attachment	null	Attachment associated with the query.
reply	null	Reply details, if available.

Error Codes

For general error details, click here.

Create a Query

Use this API to create a query.

 GET /query/create

Request body parameters

Field	Type	Description
courseId required	integer	The course ID
title required	string	The subject
body required	string	The description
attachment	file	The image, pdf or doc file

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "ticketNo": "F1693394950"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
ticketNo	string	Ticket number associated with the query.

Error Codes

Code	Description
1005	"Missing courseId"
1006	"Invalid courseId"
1007	"Missing title"
1008	"Invalid title"
1009	"Missing body"
1010	"Invalid body"
1011	"Missing attachment"
1012	"Invalid attachment"
1013	"Invalid attachment extension"
1014	"Invalid attachment size"
1015	"User not eligible"

For general error details, click here.