Version 1 | Version 2
HTTP Method & URL
GET <base-url>?Type=UserBookmarks&Version=2&UserId=<userid>&filter=<filter>& page=<page#>
Parameters
| Type | <required> Type of the request resource |
| Version | <required> API version# (e.g., Version=2) |
| UserId | <required> UserID of the user whose bookmarks you want to retrieve. |
| filter | <optional> All | Public — "All" retrieves all of the user's bookmarks while "Public" only returns the user's public bookmarks. Default is Public. |
| page | <optional> Page# (starts with 1) of the results. Defaults to 1st page. |
Description
Returns the bookmarks added by the user depending upon the value of the filter parameter.
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<TimeStamp> 2008-03-25 05:29:30 GMT </TimeStamp>
<APIVersion> 2.0 </APIVersion>
<CurrentPage> 1 </CurrentPage>
<TotalPages> 20 </TotalPages>
<PageSize> 10 </PageSize>
<Bookmarks>
<Bookmark>
<Title> CNN.com - Breaking News, U.S., World, Weather, Entertainment
_ Video News </Title>
<URL> http://www.cnn.com/ </URL>
<Description> This is the best news site that I user
</Description>
<SaveCount> -1 </SaveCount>
<Id> 204 </Id>
<Tags>
<Tag>
<Keyword> news </Keyword>
<Id> 34 </Id>
<Weight> 0 </Weight>
<DateWeight> 0 </DateWeight>
<TagCount> 0 </TagCount>
</Tag>
</Tags>
<UserName> Joe Doe </UserName>
<CreatedOn> 6 days ago </CreatedOn>
<Community>
<Name> News Community </Name>
<Id> 333 </Id>
<Type> open_group </Type>
</Community>
<CommentCount> 2 </CommentCount>
</Bookmark>
</Bookmarks>
</Response>
Notes:
- SaveCount: The value will be -1 for all bookmarks using version 1 or 2 of the Connectbeam APIs.
- The order of the bookmarks will be in reverse chronological order.
- Type values, as in <Community><Type>value</Type></Community>
- private : User's private community
- company : Public (shared with all)
- group_restricted : Restricted Group
- group_open : Open Group