Get the My Communities feed 

Get the My Communities feed to see a list of the communities to which the authenticated user is a member or pass in parameters to search for a subset of those communities that match a specific criteria.

Table 1. Atom API request details

Resource Description
service/atom/communities/my A feed of communities of which the authenticated user is a member.

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Table 2. Input parameters

Parameter Description
asc Specifies whether the results should be displayed in ascending order. Options are true or false.
email Internet email address. Search for communities of which the user you specify by email address is a member.

Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:

adam_eventide%40garden.com

Note: Do not use this parameter if IBM Connections is configured to prevent email addresses from being displayed. Use the userid parameter instead.

page Page number. Specifies the page to be returned. The default is 1.
ps Page size. Specify the number of entries to return per page.
search Well-formed full text search query. Performs a text search on community titles and descriptions.
since Includes in the resulting feed all communities updated after a specified date. Specify the date using a date-time value that conforms to RFC3339. Use an upper case "T" to separate the date and time, and an uppercase "Z" in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z.
sortField Order in which to sort the results. Options are:

  • lastmod – Sorts the results by last modified date.

  • name – Sorts the results by entry name.

  • count – Sorts the results by relevance.

tag Returns communities with the specified tag. Search by one tag at a time.
userid Unique ID that represents a specific person.


Example

To search for all communities in the My Communities view, send the following HTTP request:

> GET /communities/service/atom/communities/my HTTP/1.1
> Authorization: Basic ...
> Host: communities.enterprise.example.com:9083
> Accept: */*

The HTTP response would look as follows:

HTTP/1.1 200 OK
< Content-Type: application/atom+xml;charset=UTF-8
< Cache-Control: private, must-revalidate, no-cache=set-cookie
< Content-Language: en-US
< Set-Cookie: LtpaToken=<token>; Path=/; 
Domain=.enterprise.example.com
< Set-Cookie: LtpaToken2=<token>; Path=/; 
Domain=.enterprise.example.com
< Set-Cookie: JSESSIONID=0000It9byW6n6oF2W5zoQsGZSWQ:-1; Path=/
< Transfer-Encoding: chunked
< Date: Thu, 07 Feb 2008 15:08:03 GMT
< Server: WAS/6.1
< Expires: Thu, 01 Dec 1994 16:00:00 GMT

The following content is returned by the server:

<?xml version="1.0" encoding="UTF-8"?>
<feed 
 xmlns="http://www.w3.org/2005/Atom" 
 xmlns:app="http://www.w3.org/2007/app" 
 xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" 
 xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
 <id>http://communities.enterprise.example.com:9083/communities/service/atom/
      communities/my</id>
 <updated>2008-02-07T15:08:03.739Z</updated>
 <title type="text">Communities</title>
 <link 
  href="http://communities.enterprise.example.com:9083/communities/service/html/
    mycommunities" 
  rel="alternate">
 </link>
 <generator 
   uri="http://www.ibm.com/xmlns/prod/sn" 
   version="1.0.2">IBM Connections - Communities</generator>
 <opensearch:totalResults>1</opensearch:totalResults>
 <opensearch:startIndex>1</opensearch:startIndex>
 <opensearch:itemsPerPage>10</opensearch:itemsPerPage>
 <link 
   href="http://communities.enterprise.example.com:9083/communities/service/atom/
     communities/my" rel="self">
 </link>
 <link 
   href="http://communities.enterprise.example.com:9083/communities/service/atom/
    service" 
   rel="http://www.ibm.com/xmlns/prod/sn/service" 
   type="application/atomsvc+xml; charset=UTF-8">
 </link>
 <link 
   href="http://communities.enterprise.example.com:9083/communities/service/atom/
     communities/my?outputType=categories" 
   rel="http://www.ibm.com/xmlns/prod/sn/tag-cloud" 
   type="application/atomcat+xml; charset=UTF-8">
 </link>
 <entry>
       <id>http://communities.ibm.com:2006/service/atom/community/instance?
         communityUuid=CECG7F000001023A4B4A4F1145C58C000004</id>
       <title 
        type="text">Bird Watchers of New England</title>
       <summary type="text"></summary>
       <content type="html"></content>
       <published>2008-02-07T14:26:34.467Z</published>
       <author>
         <name>Amy jones11</name>
         <email>amy_jones11@us.example.com</email>
         <snx:userid>937965j0-4f0c-1028-5a06-db08213b51b2</snx:userid>
       </author>
       <updated>2008-02-07T14:28:24.083Z</updated>
       <contributor>
         <name>Amy jones11</name>
         <email>amy_jones11@us.example.com</email>
         <snx:userid>937965j0-4f0c-1028-5a06-db08213b51b2</snx:userid>
       </contributor>
       <category 
         term="community" 
         scheme="http://www.ibm.com/xmlns/prod/sn/type">
       </category>
       <category 
         term="bird-watching">
       </category>
       <link 
        href="http://communities.enterprise.example.com:9083/communities/service/atom/
         community/instance?communityUuid=CECG7F000001023A4B4A4F1145C58C000004" 
        rel="self">
       </link>
       <link 
        href="http://communities.enterprise.example.com:9083/communities/service/atom/
         community/instance?communityUuid=CECG7F000001023A4B4A4F1145C58C000004" 
         rel="edit">
       </link>
       <link 
        href="http://communities.enterprise.example.com:9083/communities/service/html/
         communityview?communityUuid=CECG7F000001023A4B4A4F1145C58C000004" 
        rel="alternate" 
        type="text/html">
       </link>
       <link 
        href="http://communities.enterprise.example.com:9083/communities/service/html/
         image?communityUuid=CECG7F000001023A4B4A4F1145C58C000004&amp;lastMod=
         1202394504083" 
        rel="http://www.ibm.com/xmlns/prod/sn/logo">
       </link>
       <link 
        href="http://communities.enterprise.example.com:9083/communities/service/atom/
         community/service?communityUuid=CECG7F000001023A4B4A4F1145C58C000004" 
        rel="http://www.ibm.com/xmlns/prod/sn/service" 
        type="application/atomsvc+xml; charset=UTF-8">
       </link>
       <link 
        href="http://communities.enterprise.example.com:9083/communities/service/atom/
         community/members?communityUuid=CECG7F000001023A4B4A4F1145C58C000004" 
        rel="http://www.ibm.com/xmlns/prod/sn/member-list" 
        type="application/atom+xml; charset=UTF-8">
       </link>
       <link 
        href="http://communities.enterprise.example.com:9083/communities/service/atom/
         community/bookmarks?communityUuid=CECG7F000001023A4B4A4F1145C58C000004" 
        rel="http://www.ibm.com/xmlns/prod/sn/bookmarks" 
        type="application/atom+xml; charset=UTF-8">
       </link>
       <link 
        href="http://communities.enterprise.example.com:9083/communities/service/atom/
         community/feeds?communityUuid=CECG7F000001023A4B4A4F1145C58C000004" 
        rel="http://www.ibm.com/xmlns/prod/sn/feeds" 
        type="application/atom+xml; charset=UTF-8">
       </link>
       <snx:membercount>1</snx:membercount>
       <snx:communityType>public</snx:communityType>
  </entry>
</feed>


Parent topic

Getting Communities feeds

Related reference
Add an activity member programmatically


   

 

});