Get Programs

Get Programs

This API is used to get list of programs.

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


Parameter 2 - UserName

Username of the site admin


Parameter 3 - Request Parameters

Name Value
dispatch listPrograms
xml true
subject1 metadata ID of subject for filtering the result. 

metadata ID of region for filtering the result.


metadata ID of complexity for filtering the result. Can be comma separated for multiple. 


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. 
programName Name of the program for filtering. 

Pass any custom property name value pair for filtering. E.g.


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 on successfully getting the coupon list

HTTP Response Code = HttpServletResponse.SC_OK

Response XML

<response code="0">
            <value> <![CDATA[Success]]>
        <programs numItems="12" currPage="0" pageSize="10">
            <program id="474dd0c4-a3ed-11e8-bf4c-f64887cd6dbc"
                groupId="e8851482-2ef1-11e8-ab3a-0327bc39e9e4" type="TRAINING">
                totalCredits="0.0" minCredits="0.0" courseCount="3" >
                <name><![CDATA[Onboarding program]]></name>
                <description><![CDATA[Onboarding program]]></description>
                <badgeDescription><![CDATA[Example badge]]></badgeDescription>



Code Snippet

/* Check API Call for detail */

Map<String, String> parameters = new HashMap<String, String>();


String result = connection.invokeApi("", "adminusername", parameters);


private void populateMapForCatalogList(Map<String, String> parameters) {
    parameters.put("dispatch", "listPrograms");
    parameters.put("xml", String.valueOf(true));