ListGroups

Top  Previous  Next

SOAP

ListGroups( aHandle, &aGroupList, &aErrorMsg );

 

REST

/ListGroups?Handle=<value>

returns GroupList, ErrorMsg

 

Description: ListGroups() Lists all the user groups in the system.  The group names are provided in a comma-delimited list.  

 

aHandle The value created in the call to Login().

&aGroupList The resulting list of group names in a comma-delimited format.

&aErrorMsg is populated only if an error occurred that prevented the function from succeeding.  Otherwise, this parameter is empty.

 

Example: ListGroups( lHandle, lListOfGroups, lErrorMsg );