Community articleGetting the My Communities feed
Added by IBM contributorIBM on June 20, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

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.
Tags: commapi



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.

 

Discoverability


You can derive the URL from the service document. Find the value of the href attribute of <collection> element that contains the <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="personal"/> element.

Request parameters


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

Related reference
Adding an activity member programmatically

Input
Method URI Description
GET /communities/service/atom/communities/my You can derive the URL from the service document. Find the value of the href attribute of <collection> element that contains the <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="personal"/> element.
Name Type Optional Description
asc
4.5
boolean Yes Specifies whether the results should be displayed in ascending order. Options are true or false.
email
string Yes 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
number Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps
int Yes Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 10000
search
string Yes Well-formed full text search query. Performs a text search on community titles and descriptions.
since
number Yes Includes in the resulting feed all communities updated after a specified date. Specify the date using a date-time value that conforms to http://www.ietf.org/rfc/rfc3339.txt" target="external">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.
sortBy
enumerated Yes Specifies the order in which to sort the results. Options are:
count
Sorts the entries by the number of members that belong to the item.
modified
Sorts the entries by the last modified date.
title
{{{Sorts the entries alphabetically by title. The title used is the text that is displayed in the <title> element of each entry in the feed.}}}
Note: This parameter replaces the sortField parameter. The sortField parameter and its associated options (count, lastmod, and name) are supported for backwards compatibility only; they will be deprecated in a future release.
Authorized values:
  • count
  • modified
  • title
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
<a name="d7130e221"/>
Sorts the results in ascending order.
desc
<a name="d7130e226"/>
Sorts the results in descending order.
Authorized values:
  • asc
  • desc
tag
string Yes Returns communities with the specified tag. Search by one tag at a time.
userid
string Yes Unique ID that represents a specific person.
Output
Content Type: application/atom+xml
Examples
Search for all communities in the My Communities view
> GET /communities/service/atom/communities/my HTTP/1.1

	> Authorization: Basic ...

	> Host: communities.enterprise.example.com:9083

	> Accept: */*


Response 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>