Documentation Center

Load users list in XML

This API is used to load a list of users.

Example API call

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

Parameters

ParameterDescription
targetadmin
actionget_users
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
Returns the list of all existing users
<USERS>
	     <USERBODY>
		        <USERITEM STATUS="" USER_ID="admin">
			            <LOGIN>admin</LOGIN>
			            <GROUP>ADMINISTRATOR</GROUP>
			            <LAST_NAME/>
			            <FIRST_NAME/>
			            <COMPANY/>
			            <COMPCODE/>
		        </USERITEM>
		        <USERITEM STATUS="" USER_ID="n_1459755986251_1459759113360">
			            <LOGIN> newUser </LOGIN>
			            <GROUP>EDITOR</GROUP>
			            <LAST_NAME> newUser </LAST_NAME>
			            <FIRST_NAME> newUser</FIRST_NAME>
			            <COMPANY/>
			            <COMPCODE/>
		        </USERITEM>
		             <USERITEM STATUS="" USER_ID="guest">
			            <LOGIN>guest</LOGIN>
			            <GROUP>GUEST</GROUP>
			            <LAST_NAME/>
			            <FIRST_NAME/>
			            <COMPANY/>
			            <COMPCODE/>
		        </USERITEM>
	     </USERBODY>
</USERS>
On failure
Returns nothing