API Guide v2.0

Get Bookmarks For Tag

Version 1 | Version 2

HTTP Method & URL
GET <base-url>?Type=BookmarksForTag&Version=2&TagId=<tagId>&
  Scope=<scope>&UserId=<userid>&Page=<page #>
Parameters
Type <required> Type of the request resource
Version <required> API version#
TagId <required> ID of the tag to search bookmarks against.
Scope <required> The scope of the search. Use one of the following values:
    MY_OWN_TAGS: Bookmarks created by the user
    COMPANY_TAGS: All bookmarks
    MY_OPEN_NETWORK: Bookmarks created by user in open groups
    MY_NETWORK_TAGS: Bookmarks created by anyone in open groups that
                     the user is member of
UserId <optional> If UserId is provided, then the results will also include the user's personal bookmarks.
   The results are the same as if the user is logged-in and performs the search.
Page <optional> Page# (starts with 1) of the results. Defaults to 1st page.
Description
Returns the list of all bookmarks related to the tag within the specified scope.
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>
        </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:
  • 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
  • The response is similar to that from the Get User's Bookmarks API

back to top

©2008 Connectbeam, Inc.