Documentation Center

Load list of user groups

This API retrieves the list of user groups.

Example API call

/servlets3/wietmsd?id=1459755986251&book=s1000d_bike_41&collection=default&uniqid=1459755984750&target=admin&action=get_user_groups

Parameters

ParameterDescription
targetadmin
actionget_user_groups
idA session ID that is valid for this collection and publication combination.
book The name of the publication, such as s1000d_bike_41.
collectionThe name of the collection that the publication is registered in, such as default.
uniquidTo prevent browser-side caching of data, especially with AJAX requests, it is important to make a URL unique. The most effective technique to accomplish this is to include a time parameter that is based on the time at which the call is made.

Returns

On success
<USER_GROUPS>
	     <USER_GROUP>ADMINISTRATOR</USER_GROUP>
	     <USER_GROUP>BUYER</USER_GROUP>
	     <USER_GROUP>DEVELOPER</USER_GROUP>
	     <USER_GROUP>EDITOR</USER_GROUP>
	     <USER_GROUP>GUEST</USER_GROUP>
	     <USER_GROUP>USER</USER_GROUP>
</USER_GROUPS>
On failure
Returns nothing