User Enrollment Details

Use this API to get individual user enrollment details.
 

HTTP REQUEST

GET /enrollment/{userId}/detail

PATH PARAMETERS

Field Type Description
userId
required		 integer A single user ID

QUERY STRING PARAMETERS

Field Type Description
type
required		 integer Enrollment Type. 1-course, 2-learning object.
status
required		 integer Enrollment Status. 1-upcoming/ongoing, 2-concluded.
firstRecord
required		 integer First record to return. Default: 1
count
required		 integer Number of records to be returned starting from the first record
Default: 20, Max count limit: 100		 
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "list": [
                    {
                        "enrollmentId": 14633,
                        "courseId": 1124,
                        "title": "April 2020 - Test Course",
                        "courseCode": "Apr/2020/IT",
                        "description": "This course is exclusively designed for Testing Purpose",
                        "trainer": "Trainer Horizzon",
                        "startDate": "2022-09-29",
                        "endDate": "2022-10-29",
                        "progress": "0",
                        "firstTimeViewedDate": null,
                        "status": "Ongoing",
                        "certificate": []
                    }
                ],
                "totalRecords": 11
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
Field Type Description
enrollmentId integer Enrollment ID
courseId integer Course Id
title string Mr, Mrs, Prof, Dr
lname string Last Name
courseCode string Course Code
description string Course Description
trainer string Trainer Name
startDate date Course start date
endDate date Course End Date
progress string Course Progress
firstTimeViewedDate datetime Date when trainee viewed course first time
status integer enabled/disabled status
date string certificate issued date
url string certificate file url
Code Description
1001 ‘Missing userId’
1002 ‘Invalid userId’
1003 ‘Missing enrollment type’
1004 ‘Invalid enrollment type’
1005 ‘Invalid firstRecord’
1006 ‘Invalid count’
1007 ‘Missing enrollment status’
1008 ‘Invalid enrollment status’

For general error details, click here.