Getting the My Invitations feed
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 11, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Get a list of the outstanding community invitations of the currently authenticated user or provide parameters to search for a subset of those invitations.
Tags: commapi

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="my-invitations"/> element.

Request parameters

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

Input
Method URI Description
GET /communities/service/atom/community/invites/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="my-invitations"/> element.
Name Type Optional Description
asc
boolean Yes Specifies whether the results should be displayed in ascending order. Options are true or false.
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
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
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
Examples
Return All Invitations
> GET /communities/service/atom/community/invites/my HTTP/1.1

	> Host: communities.example.com

	> Accept: */*

	>

	< HTTP/1.1 200 OK

	< Content-Type: application/atom+xml;charset=UTF-8

	...

Response returned by the server
<feed>

	<id>

	urn:lsid:ibm.com:communities:invites-9360af82-acc6-46d7-9982-beb370bebdd2

	</id>

	<title type="text">Invitations for Sue Smith</title>

	<updated>2010-07-14T14:18:10.922Z</updated>

	<generator version="3.0" uri="http://www.ibm.com/xmlns/prod/sn">

	IBM Connections - Communities

	</generator>

	<link

	href="https://communities.example.com/communities/service/atom/service"

	rel="http://www.ibm.com/xmlns/prod/sn/service">

	</link>

	<link

	href="https://communities.example.com/communities/service/atom/service"

	rel="service">

	</link>

	<link

	href="https://communities.example.com/communities/service/atom/community/invites/my"

	rel="self">

	</link>

	<opensearch:totalResults>1</opensearch:totalResults>

	<opensearch:startIndex>1</opensearch:startIndex>

	<opensearch:itemsPerPage>20</opensearch:itemsPerPage>

	<entry>

	<id>

	urn:lsid:ibm.com:communities:invite-3e88ec9d-6c1b-4a85-b709-387af023517f-9360af82-acc6-46d7-9982-beb370bebdd2

	</id>

	<title type="text">Invitation for Sue Smith to A6 Community</title>

	<category term="invite" scheme="http://www.ibm.com/xmlns/prod/sn/type">

	</category>

	<link

	href="https://communities.example.com/communities/service/atom/community/invites?communityUuid=

	3e88ec9d-6c1b-4a85-b709-387af023517f&userid=9360af82-acc6-46d7-9982-beb370bebdd2"

	rel="self">

	</link>

	<link

	href="https://communities.example.com/communities/service/atom/community/invites?communityUuid=

	3e88ec9d-6c1b-4a85-b709-387af023517f&userid=9360af82-acc6-46d7-9982-beb370bebdd2"

	rel="edit">

	</link>

	<link

	href="https://communities.example.com/communities/service/atom/community?communityUuid=

	3e88ec9d-6c1b-4a85-b709-387af023517f"

	rel="http://www.ibm.com/xmlns/prod/sn/community">

	</link>

	<updated>2010-07-14T13:29:10.934Z</updated>

	<author>

	<name>Amy Jones</name>

	<snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>

	</author>

	<content type="text"/>

	<contributor>

	<name>Sue Smith</name>

	<snx:userid>50730340-0101-102e-88e0-f78755f7e0ed</snx:userid>

	<snx:userState>active</snx:userState>

	</contributor>

	</entry>

	</feed>