Report

Enrollment Report

Use this API to get enrollment data. This end point is only accessible by Admin or Manager role.

 GET /report/enrollment

Query string parameters

Field	Type	Description
type required	integer	1 - Course, 2 - Learning Object
count required	integer	Number of records to be returned starting from the first record. Default: 20, Max count limit: 50
firstRecord required	integer	First record to return. Default: 1
filterData	JSON Array	typeId (ID of Course/Learning Object) enrollmentType (1-Active Enrollment, 2-New Enrollment) fromDate toDate generic sortType

filterData

{
    "typeId": [],
    "enrollmentType": 1,
    "fromDate": "2023-10-01",
    "toDate": "2023-10-31",
    "generic": "",
    "sortType": "asc"
}

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "list": [
                    {
                        "courseId": 105,
                        "title": "Recruitment Management",
                        "courseCode": "HIT/HR-012",
                        "firstName": "John",
                        "lastName": "Doe",
                        "email": "john.doe@example.com",
                        "department": "Marketing",
                        "designation": "Manager",
                        "enrollmentId": 1006,
                        "startDate": "2023-10-04",
                        "endDate": "2023-12-03",
                        "progress": 63,
                        "firstTimeViewedDate": "2023-11-01 11:23:27",
                        "status": "Completed",
                        "achivedDate": "2019-02-02"
                    },
                    {
                        "courseId": 106,
                        "title": "Talent Management",
                        "courseCode": "1118",
                        "firstName": "John",
                        "lastName": "Doe",
                        "email": "john.doe@example.com",
                        "department": "Marketing",
                        "designation": "Manager",
                        "enrollmentId": 117985,
                        "startDate": "2021-03-01",
                        "endDate": "2024-07-31",
                        "progress": 3,
                        "firstTimeViewedDate": "2021-03-01 10:12:31",
                        "status": "Completed",
                        "achivedDate": "2021-05-01"
                    }
                ],
                "totalRecords": 71
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
courseId	integer	The Course ID
title	string	Title of the Course/Learning Object
courseCode	string	Code of Course/Learning Object
firstName	string	First name of the user.
lastName	string	Last name of the user.
email	string	Email address of the user.
department	string	Department of the user.
designation	string	Designation of the user.
enrollmentId	integer	Enrollment ID of the user.
startDate	string	Enrollment Start Date
endDate	string	Enrollment End Date
progress	integer	Course/Learning Object Progress
firstTimeViewedDate	string	Date when Course/Learning Object was first viewed
status	string	Enrollment Status
achivedDate	string	Course/Learning Object Completion Date

Error Codes

Code	Description
1001	"Invalid firstRecord"
1002	"Invalid count"
1003	"Missing filterData"
1004	"Invalid filterData"
1005	"Missing fromDate"
1006	"Invalid fromDate"
1007	"Missing toDate"
1008	"Invalid toDate"
1009	"Missing generic"
1010	"Invalid generic"
1011	"Missing sortType"
1012	"Invalid sortType"
1013	"Missing type"
1014	"Invalid type"
1015	"Missing enrollmentType"
1016	"Invalid enrollmentType"

For general error details, click here.