List Programs' Enrollments Summary
This API return enrolled/completed count for the programs.
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 | listProgramsEnrollmentsSummary | |
getcompleted | boolean. true will return only completed records. | false |
fromDate | start date for the report. | Current month & year |
period | boolean. true: 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 program description 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> <programs currpage="0" numitems="2" pagesize="10"> <program id="a3f10df0-a716-11e9-b9b0-677f49f2df86"> <name> <!--[CDATA[TP 2]]--> </name> <code> <!--[CDATA[tp2]]--> </code> <description> <!--[CDATA[test program 2]]--> </description> <enrolled>3</enrolled> <completed>2</completed> </program> <program id="e3a044b8-a78c-11e9-b9b0-677f49f2df86"> <name> <!--[CDATA[Program 10]]--> </name> <code> <!--[CDATA[p10]]--> </code> <description> <!--[CDATA[p10 p10]]--> </description> <enrolled>2</enrolled> <completed>1</completed> </program> </programs> </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", "listProgramsEnrollmentsSummary"); }
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