HTTP Method & URL
GET <base-url>?Type=BookmarkSearchCommunities&Keyword=<searchstring>&
Version=1&UserId=<userid>
Version=1&UserId=<userid>
Parameters
| Type | <Required> Type of the request resource |
| Version | <Required> API version# |
| Keyword | <Required> Search String |
| UserId | <Optional> If userid is given, the results will also include the search of user's personal bookmarks. This would produce the same results as if the user is logged-in and searched. |
Description
Returns the list of all groups corresponding to the bookmarks matching the given search string.
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> Community for the Current World News </Description>
<BookmarkCount> 7 </BookmarkCount>
<UserCount> 7 </UserCount>
<CreatedBy> Scott Tiger </CreatedBy>
<CreatedOn> 2008-03-25 </CreatedOn>
</Community>
</Communities>
</Response>
Notes:
- The response is similar to that from the Group Search API.
- UserCount: Number of users/members that are part of that group.
- BookmarkCount: Number of bookmarks that are part of that group.
- Type: Group type has the following values:
- company : Company group
- private: Private group
- group_restricted: Restricted group
- group_open: Open group