List Courses' Enrollments Summary
This API return enrolled/completed count for the courses.
API Details
Signature of the API
connection.invokeApi(String uri, String realUserName, Map<String, String> requestParameters);
See details about invoking API in general
Parameter 1: uri
reportService.do
Parameter 2: realUserName
Username of the site admin
Parameter 3: requestParameters
Name | Value | Default |
---|---|---|
dispatch | listCoursesEnrollmentsSummary | |
getcompleted | boolean. true will return only completed records. | false |
fromDate | start date for the report. | Current month & year |
period | boolean. if range of dates needed. | false |
toDate | end date for the report. Only if period parameter is true. | |
notDistinct | boolean. To fetch distinct enrollements/completions by a user or not | true |
expand |
comma seperated list of items to include. Following can be the keys:
e.g. expand=logo,info : will include both, logo and course details in the response. |
|
Paging related parameters | ||
pageSize | Number of items in a page | 10 |
currPage | page number to fetch, must be specified for 2nd page onwards. Value of currPage starts with 0. So for page 2 specify currPage = 1 | -1 |
numItems | total records in the list, must be specified for 2nd page onwards. You can get the count of records from response of first page. then pass it as-is in subsequent pages. | 0 |
sortColumn |
|
2 |
sortAsc | boolean. true to fetch records in ascending order, false for descending. | false |
Response
On Success:
HTTP Response Code = HttpServletResponse.SC_OK
Sample response
<response code="0"> <msgs> <msg> <code>0</code> <value> <![CDATA[Success]]> </value> </msg> </msgs> <data> <courses currPage="0" numItems="2" pageSize="10"> <course id="6db8b6cc-a78c-11e9-b9b0-677f49f2df86"> <name> <![CDATA[pbc1]]> </name> <code> <![CDATA[pbc1]]> </code> <accessLevel> <![CDATA[PRIVATE]]> </accessLevel> <status> <![CDATA[ACTIVE]]> </status> <launchableWithoutSession>false</launchableWithoutSession> <autoAward>true</autoAward> <lessons>1</lessons> <tests>0</tests> <scorms>0</scorms> <days>0</days> <hours>0</hours> <minutes>0</minutes> <canPreview>true</canPreview> <embedUrl> <![CDATA[http://abc.edubrite.com/oltpublish/site/reportService.do?dispatch=embed&id=6db8b6cc-a78c-11e9-b9b0-677f49f2df86]]> </embedUrl> <enrolled>2</enrolled> <completed>1</completed> </course> <course id="0cf5903e-8c3f-11e9-a963-36ebf91faf0f"> <name> <![CDATA[catalog course 1]]> </name> <code> <![CDATA[catalogcourse1]]> </code> <accessLevel> <![CDATA[PRIVATE]]> </accessLevel> <status> <![CDATA[ACTIVE]]> </status> <launchableWithoutSession>false</launchableWithoutSession> <autoAward>true</autoAward> <lessons>1</lessons> <tests>0</tests> <scorms>0</scorms> <days>0</days> <hours>0</hours> <minutes>0</minutes> <canPreview>true</canPreview> <embedUrl> <![CDATA[http://abc.edubrite.com/oltpublish/site/reportService.do?dispatch=embed&id=0cf5903e-8c3f-11e9-a963-36ebf91faf0f]]> </embedUrl> <logoId>fcb62d2c-b8f9-11e9-9ede-96a1672069ad</logoId> <logoFileName> <![CDATA[fcb62d2c-b8f9-11e9-9ede-96a1672069ad.png]]> </logoFileName> <enrolled>5</enrolled> <completed>3</completed> </course> </courses> </data> </response>
Code Snippet
/* Check API Call for detail */ Map<String, String> parameters = new HashMap<String, String>(); populateMap(parameters); String result = connection.invokeApi("reportService.do", "adminusername", parameters); System.out.println(result); private void populateMap(Map<String, String> parameters) { parameters.put("dispatch", "listCoursesEnrollmentsSummary"); }
Related Pages
Group Management
Javascript
- Customization On Payment Page
- Validate IP Address while accessing the course
- UI Customization JavaScript Functions
- Verify Custom properties during Test Taking
- Verifying User Properties During Test
- JS Example
- example_custom_scripts
- Test Taking - Customization using callback mechanism
- Cms Calendar Example
Reports
Enrollment Management
- API - Update Event Subscription
- API - Create ExamTestInstance
- Update Program Member - via Program Session Id
- Update Program Member
- API - Self Enroll in Course Session
- Update Course Session Member
- API - Self Enroll in Program Session
- API - Self Enroll in Event
- API - Enroll Users in Course Session
- API - Enroll Users in Program Session
- API - Enroll Users in Event
- API - Enroll Users in Program
Other
Introduction
Report
- Get Sites Metadata
- Get Open Learning Items List
- API - Program Enrollment Summary
- API - Course Enrollment Summary
- Get Catalog Items List
- API - Course Session Members list
- API - Program Members List
- Event participants list
- Api - Test Attempts (Test Instances) List
- Test instance details list
- Api - Non Subscribed Event List
- Api - Subscribed Event List
- API - List All Report Schedules
- API - Get Latest Report Content For A Given Schedule ID
- API - Get Report Content For A Given Report ID
- API - List Reports For A Given Schedule
User Management
- API - User list
- API - Get user details
- Api - User Creation
- API - Create User (With Custom Properties)
- API - Update User
- API - Rename User
- API - Add user to group(s)
- API - Remove user from group(s)
- Merge User Accounts
- API - Activate User
- API - Deactivate User
- API - Change User's Origin Site
- Api - User Login (Creating User Session)
eCommerce
Quick Links
- Home
- Knowledgebase
- Video Tutorials
- Google Apps Integration
- Gilly (Plugin for Atlassian Confluence)
- EduBrite Mobile App for iPad
Gilly - EduBrite plugin for Confluence
Demo Url: http://gillydemo..edubrite.com
User: demo1, demo2
Password: password
EduBrite Mobile app for iPad
Download the app from app store
Demo Microsite: ipaddemo.edubrite.com
Signup from the app by selecting any username, and entering above demo url as training site url
EduBrite Business Edition
Demo Url: http://learnzone.edubrite.com
Signup as a user (trainee) and see the whole experience of enrolling and running the courses and tests
Group Management
Javascript
- Customization On Payment Page
- Validate IP Address while accessing the course
- UI Customization JavaScript Functions
- Verify Custom properties during Test Taking
- Verifying User Properties During Test
- JS Example
- example_custom_scripts
- Test Taking - Customization using callback mechanism
- Cms Calendar Example
Reports
Enrollment Management
- API - Update Event Subscription
- API - Create ExamTestInstance
- Update Program Member - via Program Session Id
- Update Program Member
- API - Self Enroll in Course Session
- Update Course Session Member
- API - Self Enroll in Program Session
- API - Self Enroll in Event
- API - Enroll Users in Course Session
- API - Enroll Users in Program Session
- API - Enroll Users in Event
- API - Enroll Users in Program
Other
Introduction
Report
- Get Sites Metadata
- Get Open Learning Items List
- API - Program Enrollment Summary
- API - Course Enrollment Summary
- Get Catalog Items List
- API - Course Session Members list
- API - Program Members List
- Event participants list
- Api - Test Attempts (Test Instances) List
- Test instance details list
- Api - Non Subscribed Event List
- Api - Subscribed Event List
- API - List All Report Schedules
- API - Get Latest Report Content For A Given Schedule ID
- API - Get Report Content For A Given Report ID
- API - List Reports For A Given Schedule
User Management
- API - User list
- API - Get user details
- Api - User Creation
- API - Create User (With Custom Properties)
- API - Update User
- API - Rename User
- API - Add user to group(s)
- API - Remove user from group(s)
- Merge User Accounts
- API - Activate User
- API - Deactivate User
- API - Change User's Origin Site
- Api - User Login (Creating User Session)
eCommerce
Quick Links
- Home
- Knowledgebase
- Video Tutorials
- Google Apps Integration
- Gilly (Plugin for Atlassian Confluence)
- EduBrite Mobile App for iPad
Gilly - EduBrite plugin for Confluence
Demo Url: http://gillydemo..edubrite.com
User: demo1, demo2
Password: password
EduBrite Mobile app for iPad
Download the app from app store
Demo Microsite: ipaddemo.edubrite.com
Signup from the app by selecting any username, and entering above demo url as training site url
EduBrite Business Edition
Demo Url: http://learnzone.edubrite.com
Signup as a user (trainee) and see the whole experience of enrolling and running the courses and tests