1. Knowledge Base
  2. Developer APIs
  3. Group Management
  4. API - Delete Group By ID

API - Delete Group By ID

Delete Group By ID

This API is used to delete group by specifying the group ID. 
Multiple groups can be deleted by specifying the IDs as shown in the code snippet below. 

API Details

Signature of API call:

connection.invokeApi(String uri, String realUserName, Map<String, String> requestParameters);

 

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 deleteGroupsByIds
xml true
groupId<Num> Group ID to be deleted

 

Response:

Response on successfully getting the event list

HTTP Response Code: HttpServletResponse.SC_OK

Response XML:

<response code="0">
   <msgs>
      <msg>
         <code>0218</code>
         <value>
            <![CDATA[Group(s) deleted successfully]]>
         </value>
      </msg>
   </msgs>
</response>

 

Code Snippet:

/* Check API Call for detail */

Map<String, String> parameters = new HashMap<String, String>();
parameters.put("dispatch", "deleteGroupsByIds");
parameters.put("xml", String.valueOf(true));
parameters.put("groupId0", "<Group 1 ID>");
parameters.put("groupId1", "<Group 2 ID>");
parameters.put("groupId2", "<Group 3 ID>");
 
String result = connection.invokeApi("groupService.do", "adminusername", parameters);
System.out.println(result);
 

 

Rating:
Previous
Next

Related Pages

Group Management
Javascript
Reports
Enrollment Management
Other
Introduction
Report
User Management
eCommerce

API Documentation

Examples

Client Example

Quick Links

 

Group Management
Javascript
Reports
Enrollment Management
Other
Introduction
Report
User Management
eCommerce

API Documentation

Examples

Client Example

Quick Links