Get Catalog Items
This API is used to get a list of items in the catalog.
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 | getCatalogItems |
xml | true |
productType | Optional - can be CS, PS or EV to get only course sessions, program sessions or events. By default, all are returned. |
subject1 | metadata ID of the subject for filtering the result. |
region1 |
metadata ID of the 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 item for filtering. Can be the name of the course session, program session, or event. |
paging parameters | |
currPage | page number to fetch, must be specified for 2nd page onwards. Value of currPage starts at 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 the response of the first page. then pass it as-is in subsequent pages. |
pageSize | Number of items in a page |
Response
Response on successfully getting the list
HTTP Response Code = HttpServletResponse.SC_OK
Response XML
<response code="0">
<msgs>
<msg>
<code>0</code>
<value>
<![CDATA[ Success ]]>
</value>
</msg>
</msgs>
<data>
<items numItems="22" currPage="0" pageSize="10">
<item id="3901cb71-6ce1-11e5-83c0-00163e006318" entityId="48ab6d4a-6ce1-11e5-83c0-00163e006318"
entityType="COURSE_SESSION" price="0.0" currency="USD"
freeByAutoCode="true" freeByCodeId="8367f959-72af-11e7-8cba-00163e0076fa">
<courseSession id="58ab644a-6ce1-11e5-83c0-00163e006318"
courseId="12592969-6ce0-11e5-83c0-00163e006318"
maxSubscriptionDays="30">
<name>
<![CDATA[ Weekly Schedule Example 1 ]]>
</name>
<code>
<![CDATA[ wkex1 ]]>
</code>
<description>
<![CDATA[ Example course with weekly schedule ]]>
</description>
<status>
<![CDATA[ ACTIVE ]]>
</status>
<startDate>1454400000000</startDate>
<endDate>1587279600000</endDate>
<accessType>OPEN</accessType>
<student>false</student>
<teacherOrAdmin>true</teacherOrAdmin>
<canEnroll>false</canEnroll>
<groupId>e9b94e07-6cdc-11e5-83c0-00163e006318</groupId>
<groupName>
<![CDATA[ Training ]]>
</groupName>
<embedUrl>
<![CDATA[
https://xyz.edubrite.com/oltpublish/site/catalogService.do?dispatch=embed&id=12597969-6ce0-11e5-83c0-00163e006318&courseSessionId=58ab6d4a-6ce1-11e5-83c0-00163e006318
]]>
</embedUrl>
<credits>5.0</credits>
<logoId>38157b10-8284-11e5-83c0-00163e006318</logoId>
<logoFileName>
<![CDATA[ 38157b10-8284-11e5-83c0-00163e006318.png ]]>
</logoFileName>
<subject>
<![CDATA[ Overview ]]>
</subject>
<region>
<![CDATA[ USA Mexico ]]>
</region>
</courseSession>
</item>
<item id="2bf8628e-f3b0-11e6-8cba-00163e0076fa" entityId="2b27cf3a-f3b0-11e6-8cba-00163e0076fa"
entityType="PROGRAM_SESSION" price="0.0" currency="USD"
freeByAutoCode="true" freeByCodeId="2367f259-12af-12e7-8cba-00163e0076fa">
<programSession id="2bf7cf3a-f3b0-1126-8cba-00163e0076fa"
programId="2e0cc530-f311-1126-8cba-00163e0076fa" numCourses="0"
maxSubscriptionDays="365">
<name>
<![CDATA[ Sales Professional Accreditations 2015 ]]>
</name>
<code>
<![CDATA[ SALES2015 ]]>
</code>
<description>
<![CDATA[
A sales-related role, then your first step on your education journey is to become a Sales Expert.
]]>
</description>
<status>
<![CDATA[ ACTIVE ]]>
</status>
<startDate>1483296840000</startDate>
<endDate>1514746440000</endDate>
<accessType>OPEN</accessType>
<canEnroll>true</canEnroll>
<canBuy>false</canBuy>
<credits>0.0</credits>
<logoId>2561c976-40f6-11e7-b7e1-00163e0076fa</logoId>
<logoFileName>
<![CDATA[ 2561c976-40f6-11e7-b7e1-00163e0076fa.png ]]>
</logoFileName>
<skillLevel>
<![CDATA[ Sales Engineer ]]>
</skillLevel>
<complexity>
<![CDATA[ Marketing and Sales ]]>
</complexity>
</programSession>
</item>
<item id="e1100266-9129-11e7-81da-00163e0076fa" entityId="e0fc28a9-9129-11e7-81da-00163e0076fa"
entityType="EVENT" price="0.0" currency="USD" freeByAutoCode="true"
freeByCodeId="83672959-12af-11e7-8cba-00163e0076fa">
<event id="e0fc28a9-9129-11e7-81da-00163e0076fa" type="CONFERENCE"
status="ACTIVE" accessType="PAID" fullAndWaitListEnabled="false"
full="false" waitlisted="false">
<name>
<![CDATA[ Live Meeting Sep 27, 2017 ]]>
</name>
<startDate>1506529800000</startDate>
<endDate>1506531000000</endDate>
<subscribed>false</subscribed>
<partiallySubscribed>false</partiallySubscribed>
<logo>
<![CDATA[ ../att/4f7178e2-924e-11e7-81da-00163e0076fa ]]>
</logo>
<logoId>4f7178e2-924e-11e7-81da-00163e0076fa</logoId>
<logoFileName>
<![CDATA[ 4f7278e2-924e-11e7-81da-00163e0076fa.png ]]>
</logoFileName>
<canSubscribe>true</canSubscribe>
<contactInfo>
<![CDATA[ 47537715 ]]>
</contactInfo>
<location>
<![CDATA[ 568053832219070731 ]]>
</location>
<allDay>false</allDay>
<eventItems></eventItems>
</event>
</item>
</items>
</data>
</response>
Code Snippet
/* Check API Call for detail */
System.out.println(result);
parameters.put("dispatch", "getCatalogItems");
parameters.put("xml", String.valueOf(true));
}
API Documentation
Examples
- User Creation
- User Update
- User List
- Get User Details
- Add User to Group(s)
- Remove User from Group(s)
- User Activate
- User Deactivate
- User Login
- Group List
- Group Membership
- Course Subscription(Coupon Code)
- Subscribed Events List
- Non Subscribed Events List
- Test Instances in Microsite
- Forum APIs
- Javascript Example
Client Example
Quick Links
- Home
- Getting Started
- Knowledgebase
- Video Tutorials
- Google Apps Integration
- Gilly (Plugin for Atlassian Confluence)