getUserListRequest

Returns all the users on a GroupWise post office.

Request

<getUserListRequest>
   <name type="string"/>
   <key type="string"/>
   <noop type="boolean"/>
</getUserListRequest>

Response

<getUserListResponse>
   <users type="types:UserList"/>
   <status" type="types:Status"/
</getUserListReponse>

Elements

name

Specifies the name of the trusted application.

key

Specifies the value of the trusted application.

noop

Used to test the connection to the POA without having to be logged in as a user.

--For GroupWise 8.0 SP1 and later.

users

Specifies the list of users on a post office. Each user in the list has a name, email address, unique identifier (uuid), user ID, and its recipient type.

code

Returns the error number related to the event. 0 indicates that the request was successful.

status

Returns the success or failure of the method.

Remarks

This method is available only to applications that have logged in as a trusted application. Those with user or proxy authentication will be denied.

Trusted applications are set up by an administrator. A GroupWise administrator provides the trusted application name and key to an application.

If an application has already logged in as a trusted application, the name and key elements are not required. Otherwise, the name and key elements are required.

Example

<getUserListRequest> 
   <name>GWWS</name> 
   <key>C0C0A3D206A90000875068005A00E700C0C0A3D306A90000875068
       005A00E700</key> 
</getUserListRequest>

<getUserListResponse> 
   <users> 
      <user> 
         <name>Resouce1</name> 
         <email>Resouce1.po1.domain1</email> 
         <uuid>EC1AA110-083F-0000-8109-D1000000AC00</uuid> 
         <userid>Resouce1</userid> 
         <recipType>Resource</recipType> 
      </user> 
      <user> 
         <name>u1</name> 
         <email>u1.po1.domain1</email> 
         <uuid>1DEB6970-175B-0000-890F-6E00D5004E00</uuid> 
         <userid>u1</userid> 
         <recipType>User</recipType> 
      </user>
      ...
   </users> 
   <status> 
      <code>0</code> 
   </status> 
</getUserListResponse>