Get a person's message board entries 

Get a feed that lists all of the entries posted to a person's message board, including the board owner's status message, the messages posted by other people, and some of the comments associated with the messages.

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

Table 1. Atom API request details

Resource Description
/atom/mv/theboard/entries.do Gets a feed that lists all of the entries in a person's message board. Provide one of the following parameters to specify the owner of the message board that you want to retrieve 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 each 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 who owns the message board that you want to retrieve information about.

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.
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 whether to show the most recent or the oldest entries first.

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.

<feed>
  <id>tag:connections.ibm.com,2008,entry:feed</id>
  <generator version="3.0" uri="http://www.ibm.com/xmlns/prod/sn">
   IBM Connections - Profiles
  </generator>
  <title type="text">The Board for Amy Jones5</title>
  <link 
   href="https://profiles.enterprise.example.com:9447/profiles/atom/mv/theboard/
   entries.do?email=ajones5%40us.example.com" 
   rel="self"/>
  <opensearch:itemsPerPage>10</opensearch:itemsPerPage>
  <entry>
    <id>
     tag:connections.ibm.com,2008,entry:163f0919-b3f8-42ae-b4a8-386240d50621
    </id>
    <title type="text">hello amy</title>
    <category 
     term="entry" 
     scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
    <category 
     term="simpleEntry" 
     scheme="http://www.ibm.com/xmlns/prod/sn/message-type"/>
    <published>2009-03-18T19:44:55.281Z</published>
    <updated>2009-03-18T19:45:19.421Z</updated>
    <author>
      <name>Amy Jones5</name>
      <userid>5adff8c0-7d67-102c-845a-e2ebc3ec5536</userid>
      <email>ajones5@us.example.com</email>
    </author>
    <contributor>
      <name>Amy Jones5</name>
      <userid>5adff8c0-7d67-102c-845a-e2ebc3ec5536</userid>
      <email>ajones5@us.example.com</email>
    </contributor>
    <link 
     href="https://profiles.enterprise.example.com:9447/profiles/atom/mv/theboard/
      entry.do?entryId=163f0919-b3f8-42ae-b4a8-386240d50621" 
     rel="self"/>
    <link 
     href="https://profiles.enterprise.example.com:9447/profiles/atom/mv/theboard/
      comments.do?entryId=163f0919-b3f8-42ae-b4a8-386240d50621" 
     rel="replies" 
     thr:total="1"/>
    <summary type="text">hello amy</summary>
    <content type="text">hello amy</content>
  </entry>
</feed>


Parent topic

Getting Profiles feeds

Related reference
Retrieve messages from a message board
Message content
Profiles comment content
Status content


   

 

});

+

Search Tips   |   Advanced Search