Groups Search by Path

Group By Path

This API is used to obtain the list of groups for a path. 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


Parameter 2 - UserName

Username of the site admin


Parameter 3 - Request Parameters

Name Value
dispatch getByPath
xml true
path / separate path expression that contains either * or name or code for each level of the path spec in a group hierarchy.



Response on successfully getting the group list

HTTP Response Code = HttpServletResponse.SC_OK

Response XML

<response code="0">


         <group id="e48b628e-c31b-11e1-a74c-e96024937694">
            <name><![CDATA[Group ABC]]></name>           






Code Snippet


    /*  Check API Call for detail generic code, returns all top level groups */
    Map<String, String> parameters = new HashMap<String, String>();
    parameters.put("dispatch", "getByPath");
    parameters.put("xml", String.valueOf(true));
    parameters.put("path", "{name:\"Training\"}/{name: \"Corporate\"}/{name: \"Sales\"}");
    String retStr = connection.invokeApi("", "adminusername", parameters);