Get the All Communities feed 

Get the All Communities feed to see a list of all public communities to which the authenticated user has access or pass in parameters to search for communities that match a specific criteria.

Table 1. Atom API request details

    Resource

    Description

    service/atom/communities/all

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-time value since 1970 in milliseconds (for example, 1321906696443 for a date and time near Nov 21, 2011 9:18:16 PM). In Java you can get the required value with System.currentTimeMillis().

    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 that are identified with the tag wiki, send the following HTTP request:

> GET /communities/service/atom/communities/all?tag=wiki HTTP/1.1
> Host: communities.example.com:9080
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: application/atom+xml;charset=UTF-8
...

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:snx="http://www.ibm.com/xmlns/prod/sn" 
   xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <id>http://communities.example.com:9080/communities/service/atom/communities/all?
   tag=wiki</id> 
  <updated>2008-02-06T19:19:14.187Z</updated> 
  <title type="text">Communities</title> 
  <link href="http://communities.example.com:9080/communities/service/html/
   allcommunities" rel="alternate" /> 
  <generator 
   uri="http://www.ibm.com/xmlns/prod/sn" 
   version="1.0.2">IBM Connections - Communities</generator> 
  <opensearch:totalResults>2</opensearch:totalResults> 
  <opensearch:startIndex>1</opensearch:startIndex> 
  <opensearch:itemsPerPage>10</opensearch:itemsPerPage> 
  <link href="http://communities.example.com:9080/communities/service/atom/
   communities/all?tag=wiki" rel="self" /> 
  <link href="http://communities.example.com:9080/communities/service/atom/service" 
   rel="http://www.ibm.com/xmlns/prod/sn/service" 
   type="application/atomsvc+xml; charset=UTF-8" /> 
  <link href="http://communities.example.com:9080/communities/service/atom/
   communities/all?tag=wiki&outputType=categories" 
   rel="http://www.ibm.com/xmlns/prod/sn/tag-cloud" 
   type="application/atomcat+xml; charset=UTF-8" /> 
  <entry>
    <id>http://communities.example.com:2006/service/atom/community/instance?
     communityUuid=FB1G09211E1920C3324C2F79332E7C000034</id> 
  <title type="text">Test Communities including Social Text Wiki</title> 
  <summary type="text">Test Communities including Social Text Wiki</summary> 
  <content type="html" /> 
  <published>2007-12-19T18:35:41.968Z</published> 
  <author>
    <name>ANDY MALONE</name> 
    <email>amalone@us.example.com</email> 
    <snx:userid>937965j0-4f0c-1028-5a06-db07163b51b2</snx:userid>
  </author>
  <updated>2007-12-19T18:38:35.562Z</updated> 
  <contributor>
    <name>ANDY MALONE</name> 
    <email>amalone@us.example.com</email>
    <snx:userid>937965j0-4f0c-1028-5a06-db09663b51b2</snx:userid> 
  </contributor>
  <category term="community" scheme="http://www.ibm.com/xmlns/prod/sn/type" /> 
  <category term="social-text" /> 
  <category term="wiki" /> 
  <link href="http://communities.example.com:9080/communities/service/atom/
   community/instance?communityUuid=FB1G09211E1920C3324C2F79332E7C000034" 
   rel="self" /> 
  <link href="http://communities.example.com:9080/communities/service/atom/
   community/instance?communityUuid=FB1G09211E1920C3324C2F79332E7C000034" 
   rel="edit" /> 
  <link href="http://communities.example.com:9080/communities/service/html/
   communityview?communityUuid=FB1G09211E1920C3324C2F79332E7C000034" 
   rel="alternate" type="text/html" /> 
  <link href="http://communities.example.com:9080/communities/service/html/image?
   communityUuid=FB1G09211E1920C3324C2F79332E7C000034&lastMod=1198089515562" 
   rel="http://www.ibm.com/xmlns/prod/sn/logo" /> 
  <link href="http://communities.example.com:9080/communities/service/atom/community/
   service?communityUuid=FB1G09211E1920C3324C2F79332E7C000034" 
   rel="http://www.ibm.com/xmlns/prod/sn/service" 
   type="application/atomsvc+xml; charset=UTF-8" /> 
  <link href="http://communities.example.com:9080/communities/service/atom/
   community/members?communityUuid=FB1G09211E1920C3324C2F79332E7C000034" 
   rel="http://www.ibm.com/xmlns/prod/sn/member-list" 
   type="application/atom+xml; charset=UTF-8" /> 
  <link href="http://communities.example.com:9080/communities/service/atom/
   community/bookmarks?communityUuid=FB1G09211E1920C3324C2F79332E7C000034" 
   rel="http://www.ibm.com/xmlns/prod/sn/bookmarks" 
   type="application/atom+xml; charset=UTF-8" /> 
  <link href="http://communities.example.com:9080/communities/service/atom/community/
   feeds?communityUuid=FB1G09211E1920C3324C2F79332E7C000034" 
   rel="http://www.ibm.com/xmlns/prod/sn/feeds" 
   type="application/atom+xml; charset=UTF-8" /> 
  <snx:membercount>3</snx:membercount> 
  <snx:communityType>public</snx:communityType> 
  </entry>
  <entry>
    <id>http://communities.ibm.com:2006/service/atom/community/instance?
     communityUuid=7ADG09211E190B36BC0681443F053900001A</id> 
    <title type="text">HelloWorld Community</title> 
    <summary type="text">Testin 1 2 3</summary> 
    <content type="html" /> 
    <published>2007-01-12T23:47:17.421Z</published> 
    <author>
      <name>Stewart Simon</name> 
      <email>simon@us.example.com</email> 
      <snx:userid>937965j0-4f0c-1028-5a06-db08213b51b2</snx:userid>
    </author>
    <updated>2007-10-26T13:29:57.101Z</updated> 
    <contributor>
      <name>MICHAEL JONES</name> 
      <email>jonesm@us.example.com</email> 
      <snx:userid>937965j0-4f0c-1028-5a06-db08275b51b2</snx:userid>
    </contributor>
    <category term="community" scheme="http://www.ibm.com/xmlns/prod/sn/type" /> 
    <category term="wiki" /> 
    <link href="http://communities.example.com:9080/communities/service/atom/
     community/instance?communityUuid=7ADG09211E190B36BC0681443F053900001A" 
     rel="self" /> 
    <link href="http://communities.example.com:9080/communities/service/atom/
     community/instance?communityUuid=7ADG09211E190B36BC0681443F053900001A" 
     rel="edit" /> 
    <link href="http://communities.example.com:9080/communities/service/html/
     communityview?communityUuid=7ADG09211E190B36BC0681443F053900001A" 
     rel="alternate" 
     type="text/html" /> 
    <link href="http://communities.example.com:9080/communities/service/html/image?
     communityUuid=7ADG09211E190B36BC0681443F053900001A&lastMod=1193405397101" 
     rel="http://www.ibm.com/xmlns/prod/sn/logo" /> 
    <link href="http://communities.example.com:9080/communities/service/atom/
     community/service?communityUuid=7ADG09211E190B36BC0681443F053900001A" 
     rel="http://www.ibm.com/xmlns/prod/sn/service" 
     type="application/atomsvc+xml; charset=UTF-8" /> 
    <link href="http://communities.example.com:9080/communities/service/atom/
     community/members?communityUuid=7ADG09211E190B36BC0681443F053900001A" 
     rel="http://www.ibm.com/xmlns/prod/sn/member-list" 
     type="application/atom+xml; charset=UTF-8" /> 
    <link href="http://communities.example.com:9080/communities/service/atom/
     community/bookmarks?communityUuid=7ADG09211E190B36BC0681443F053900001A" 
     rel="http://www.ibm.com/xmlns/prod/sn/bookmarks" 
     type="application/atom+xml; charset=UTF-8" /> 
    <link href="http://communities.example.com:9080/communities/service/atom/
     community/feeds?communityUuid=7ADG09211E190B36BC0681443F053900001A" 
     rel="http://www.ibm.com/xmlns/prod/sn/feeds" 
     type="application/atom+xml; charset=UTF-8" /> 
    <snx:membercount>2</snx:membercount> 
    <snx:communityType>public</snx:communityType> 
  </entry>
</feed>


Parent topic

Getting Communities feeds


December 20, 2011 9:57:33 AM
   

 

Dec 20, 2011 9:57:33 AM 1 Submitted by Matthias Hub on Nov 21, 2011 3:45:39 PM

Re: Getting the All Communities feed

Regarding the "since" parameter: as it turned out the required value of that parameter is not as stated a string according to RFC3339.but the time since 1970 in milliseconds (e.g. 1321906696443 for something around Nov 21, 2011 9:18:16 PM). In Java you can get the required value easily with System.currentTimeMillis(). I guess this also holds for the other search feeds.

});