Get the My Invitations feed 

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

Table 1. Atom API request details

Resource Description
Available from the href attribute of the My Invitations collection in the service document A feed of invitations

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

Example

To return all invitations, send the following HTTP request:

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

The following content is 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>


Parent topic

Getting Communities feeds

Related reference
Retrieve an invitation


   

 

});