HTTP Method & URL
GET <base-url>?Type=UserCommunities&Version=1&UserId=<userid>&filter=<filter>
&page=<page#>
&page=<page#>
Parameters
| Type | <required> Type of the request resource |
| Version | <required> API version# |
| UserId | <required> UserID of the user whose groups you want to retrieve. |
| filter | <optional> All | Public — "All" retrieves all of the user's groups while "Public" only returns the user's public groups. Default is Public. |
| page | <optional> Page# (starts with 1) of the results. Defaults to 1st page. |
Description
Returns the list of groups that the specified user is the owner or member of based on the filter value..
Example Response
<?xml version="1.0" encoding="UTF-8"?> <Response> <TimeStamp> 2008-03-25 05:29:30 GMT </TimeStamp> <APIVersion> 1.0 </APIVersion> <CurrentPage> 1 </CurrentPage> <TotalPages> 20 </TotalPages> <PageSize> 10 </PageSize> <Communities>
<Community>
<Name> News Community </Name>
<Id> 333 </Id>
<Type> group_open </Type>
<Description> Group for the Current World News </Description>
<BookmarkCount> 7 </BookmarkCount>
<UserCount> 7 </UserCount>
<CreatedBy> Scott Tiger </CreatedBy>
<CreatedOn> Mar 25, 2008 </CreatedOn>
</Community>
</Communities> </Response>
Notes:
- Communities have been renamed to Groups for Connectbeam Spotlight 3.0
- Type: Group type has the following values:
- private: User's personal (private) group
- group_restricted: Restricted group
- group_open: Open group
- The "company" group (default group for the entire company) is not shown in the list.