Get Course Sessions
This API is used to get list of course sessions.
API Details
Signature of API call
connection.invokeApi(String uri, String realUserName, Map<String, String> requestParameters);
See details about invoking API in general
Parameter 1 - URI
catalogService.do
Parameter 2 - UserName
Username of the site admin
Parameter 3 - Request Parameters
Name | Value |
dispatch | listCourseSessions |
xml | true |
subject1 | metadata ID of subject for filtering the result. |
region1 |
metadata ID of region for filtering the result. |
complexity |
metadata ID of complexity for filtering the result. Can be comma separated for multiple. |
skillLevel |
metadata ID of skillLevel for filtering the result. Can be comma separated for multiple. |
exam | metadata ID of exam for filtering the result. Can be comma separated for multiple. |
courseName | Name of the course for filtering. |
sessionName | Name of the course session for filtering. |
customPropertyMap[property-name] |
Pass any custom property name value pair for filtering. E.g. customPropertyMap[type]=ILT |
paging parameters | |
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 |
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. |
pageSize | Number of items in a page |
Response
Response on successfully getting the coupon list
HTTP Response Code = HttpServletResponse.SC_OK
Response XML
<response code="0">
<msgs>
<msg>
<code>0</code>
<value> <![CDATA[Success]]>
</value>
</msg>
</msgs>
<data>
<courseSessions numItems="98" currPage="0"
pageSize="10">
<courseSession
id="6728757a-17aa-11ea-8bef-7f71b8473b53"
courseId="4cc0b0b2-17aa-11ea-8bef-7f71b8473b53" showPeriod="true" externalId="xxx-xxx-xxx-xxx">
<name><![CDATA[ps1221]]></name>
<code><![CDATA[ps1221]]></code>
<description><![CDATA[]]>
</description>
<status><![CDATA[ACTIVE]]></status>
<startDate>1575532800000</startDate>
<endDate>1578211200000</endDate>
<accessType>BY_INVITE</accessType>
<student>false</student>
<teacherOrAdmin>true</teacherOrAdmin>
<canEnroll>false</canEnroll>
<groupId>e8851482-2ef1-11e8-ab3a-0327bc39e9e4</groupId>
<groupName><![CDATA[Training]]></groupName>
<embedUrl><![CDATA[https://site1.edubrite.com/oltpublish/site/catalogService.do?dispatch=embed&id=4cc0b0b2-17aa-11ea-8bef-7f71b8473b53&courseSessionId=6728757a-17aa-11ea-8bef-7f71b8473b53]]></embedUrl>
<credits>0.0</credits>
<logoFileName><![CDATA[/oltpublish/1/images/generic-tile.png]]></logoFileName>
<logoAbsUrl><![CDATA[https://site1.edubrite.com/oltpublish/1/images/generic-tile.png]]></logoAbsUrl>
<properties>
<property>
<name><![CDATA[aa]]></name>
<value><![CDATA[asas]]></value>
</property>
<property>
<name><![CDATA[EqCourseSessionIDs]]></name>
<value><![CDATA[asasas]]></value>
</property>
</properties>
</courseSession>
.....
</courseSessions>
</data>
</response>
Code Snippet
/* Check API Call for detail */
Map<String, String> parameters = new HashMap<String, String>();
populateMapForCatalogList(parameters);
String result = connection.invokeApi("catalogService.do", "adminusername", parameters);
System.out.println(result);
private void populateMapForCatalogList(Map<String, String> parameters) {
parameters.put("dispatch", "listCourseSessions");
parameters.put("xml", String.valueOf(true));
}
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