API - Delete Groups by Names

Delete Groups By Names

This API is used to delete groups by specifying groups names.


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 user (for my groups) and site admin(for site groups)


Parameter 3 - Request Parameters

Name Value
dispatch deleteGroups
xml true
parentId Parent Group ID
groupName<Num> Group name to be deleted



Response on successfully getting the event list

HTTP Response Code = HttpServletResponse.SC_OK

Response XML

<response code="0">
            <![CDATA[Group(s) deleted successfully]]>



Code Snippet

/* Check API Call for detail */

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

parameters.put("dispatch", "deleteGroups");

parameters.put("xml", String.valueOf(true));

parameters.put("parentId", "<Parent Group ID>");

parameters.put("groupName0", "Sales Team A");

parameters.put("groupName1", "Sales Team B");

parameters.put("groupName2", "Sales Team C");


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