Get the messages of your colleagues 

Get a feed that lists the recent posts made by your colleagues.

See Authenticating requests for information about how to authenticate the request.

Table 1. Atom API request details

Resource Description
/atom/mv/theboard/entries/related.do Gets a feed that lists the messages, status messages, and some of the message comments posted to the boards of a person's colleagues. Provide one of the following parameters to specify the person whose colleagues you want information about:

  • email

  • userid

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

Note: All search parameters support the use of the wildcards % or *. Use % to match any single character; encode it properly using %25. Use * to match zero or more characters.

Table 2. Input parameters

Parameter Description
comments Specifies whether or not to include the comments associated with the message. The options are:

  • all: Includes the first, second-to-last, and last comment associated with an entry. The comments are represented as top-level entries. For example:

      <feed>
        <entry>
        <entry *a comment*>
      </feed>

  • inline: Includes the first, second-to-last, and last comment associated with an entry. The comments are represented as entries within a comments element. For example:

      <feed>
        <entry>
          <comments>
            <entry *a comment*>
          </comments>
        </entry>
      </feed>

  • none: Includes none of the comments

email Internet email address of the person for which you want to retreive colleague messages.

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: Provide either this parameter or the userid parameter. Do not provide this parameter if IBM Connections is configured to prevent email addresses from being displayed. It will return an error code. Use the key or userid parameters instead.

messageTypes Specifies the type of messages you want to return in the feed. The options are:

  • status

  • simpleEntry

You can specify more than one option; separate multiple message types with a comma. By default, all message types are included.

ps Page size. Specifies the number of entries to return per page.
since Includes in the resulting feed all entries published 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. You must use the sinceEntryId parameter with this parameter.
sinceEntryId Includes in the resulting feed all entries published after a specified entry, which is specified by ID. You must use the since parameter with this parameter. An ID is specified for each entry in the board feed.
sortBy Defines the order in which to display the entries in the returned feed. The option are:

  • lastMod: Sorts the status messages by the date on which they were last modified.

  • published: Sorts the status messages by the date on which they were published.

Use with the sortOrder parameter to specify which to show first: the most recent or oldest.

sortOrder Specifies the order in which to list the feed entries. The options are:

  • asc: Displays the entries in ascending order.

  • desc: Displays the entries in descending order.

userid Unique ID that represents a specific person. The user ID is stored in the div element that has the x-lconn-userid class attribute.

Note: Provide either this parameter or the email parameter.


Parent topic

Getting Profiles feeds

Related reference
Retrieve status messages
Status content


   

 

});