Group List
This API is used to obtain the list of groups, both for a specific user (user subscribed groups aka my groups) and all groups available in the site. For each group, the API returns the group id, group name, total current member count and group owners name and username.
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
groupService.do
Parameter 2 - UserName
Username of the user (for my groups) and site admin(for site groups)
Parameter 3 - Request Parameters
Name | Value |
dispatch | listMyGroups (listSiteGroups) |
xml | true |
pageSize | Optional - Default value is 0 |
currPage |
Optional - default value is 0.
to fetch multiple pages, this api needs to be called multiple times, with value for currPage parameter 0, 1, 2 .... upto the total number of items available from the api.
First call to the API carries a response XML which contains information about the total number of items available. |
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. |
Response
Response on successfully getting the event list
HTTP Response Code = HttpServletResponse.SC_OK
Response XML
<response code="0">
<msgs>
<msg>
<code>0</code>
<value>
<![CDATA[Success]]>
</value>
</msg>
</msgs>
<data>
<groups numItems="3" currPage="-1" pageSize="10">
<group id="c4f78d58-c31b-11e1-a74c-e96024937694">
<name><![CDATA[Fave3Group1]]></name>
<code><![CDATA[12345]]></code>
<membercount>1</membercount>
<groupOwnerFirstName>Chris</groupOwnerFirstName>
<groupOwnerLastName>Henry</groupOwnerLastName>
<groupOwnerUserName>chenry</groupOwnerUserName>
</group>
<group id="db960dec-c31a-11e1-a74c-e96024937694">
<name><![CDATA[Fave3Group2]]></name>
<membercount>1</membercount>
<groupOwnerFirstName>Chris</groupOwnerFirstName>
<groupOwnerLastName>Henry</groupOwnerLastName>
<groupOwnerUserName>chenry</groupOwnerUserName>
</group>
<group id="e48b628e-c31b-11e1-a74c-e96024937694">
<name><![CDATA[Fave3Group3]]></name>
<membercount>1</membercount>
<groupOwnerFirstName>Chris</groupOwnerFirstName>
<groupOwnerLastName>Henry</groupOwnerLastName>
<groupOwnerUserName>chenry</groupOwnerUserName>
</group>
</groups>
</data>
</response>
Code Snippet
/* Check API Call for detail generic code */
Map<String, String> parameters = new HashMap<String, String>();
parameters.put("dispatch", "listSiteGroups");
parameters.put("xml", String.valueOf(true));
parameters.put("pageSize", "10");
String retStr = connection.invokeApi("groupService.do", "adminusername", parameters);
System.out.println(retStr);
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
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)
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
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)
Comment