API Guide v2.0

Get Group Bookmarks

Version 1 | Version 2

HTTP Method & URL
GET <base-url>?Type=CommunityBookmars&CommunityId=<id>&Version=2& Page=<page#>
Parameters
Type <Required> Type of the request resource
Version <Required> API version#
CommunityId <Required> ID of the group
Page <optional> Page# (starts with 1) of the results. Defaults to 1st page.
Description
This call gets all the bookmarks in a particular group. The corresponding tags are retrieved using a different API call.
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> 
      <Name> CNN.com - Breaking News, U.S., World, Weather, Entertainment
 _ Video News </Name>
      <URL> http://www.cnn.com/ </URL>
      <SaveCount> -1 </SaveCount>
      <Id> 204 </Id>
      <Tags>
        <Tag>
          <Keyword> news </Keyword>
          <Id> 34 </Id>
          <Weight> 1 </Weight>
        </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: Number of times the URL is saved (It is -1 for all bookmarks in this result in version 1 and 2 of the Connectbeam API).
  • The weight of the tags is always 0 in this result.
  • 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
  • Similar format to that of Get User's Bookmarks API

back to top

©2008 Connectbeam, Inc.