Create Group By Path

This API is used to create a sub group by specifying the path to the parent group.

Path syntax is as follows:

Path = segment/segment/......

segment = * | {code: "group code"} | {name: "group name"}

Each segment can contain * (matches any group at that level), name of the group or code of the group. API can return one or more groups depending on the matches

Example of Path

Path = {name:"Training"}/{name: "Corporate"}/{name: "Sales"}

Path = {name:"Training"}/{name: "Corporate"}/*

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 site admin

Parameter 3 - Request Parameters

Response

Response on successfully creating the group

HTTP Response Code = HttpServletResponse.SC_OK

Response XML

Code Snippet

/* Check API Call for detail */