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

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