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

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));
}