Search for a user's profile 

Retrieve a feed that contains a specific user's profile.

This method returns a feed of profile as opposed to retrieving the Atom entry of the profile. If you want to retrieve an Atom entry document, see Retrieve a profile entry. The content element of each returned entry includes the vcard information for the person being represented by the entry. In addition, it provides a list of the fully qualified URLs for each IBM Connections application link displayed in the business card.

Table 1. Atom API request details

Resource Description
/atom/profile.do Retrieves a user's profile.

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

Table 2. Input parameters

Parameter Description
email Internet email address of the user whose profile you want to retrieve. Alternately, you can retrieve a set of profiles for multiple users. To do so, provide multiple email addresses, each separated by a comma with no spaces before or after it.

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. It will return an error code 400 for an invalid request. Use the key or userid parameters instead.
This parameter is ignored if the userid parameter is also specified.

format Specifies whether you want a full profile or partial profile to be returned. Options are lite or full. The default value is lite.
key An ID generated by Profiles to identify a person.

Note: A user's key value is contained in the element with a class attribute value of x-profile-key in the user's profile feed. You can access a user's feed by searching all profiles by name, which returns information you can then use to retrieve the person's feed.

output Controls the output type of the Profiles entry content element. Options are:
hcard

    Produces content according to the xhtml/vcard microformat specification. hcard content is in XML format which means it can be addressed by XPath. This value is the default option.

vcard

    Produces content according to the VCARD 2.1 standard. vcard content is text based, but more compact. This output format specifies the rel="edit" link element for the profile. Use this format if you want to update a profile.

userid Unique ID that represents a specific person. This value is specified in the <snx:userid> element.

Alternately, you can retrieve a set of profiles for multiple users. To do so, provide multiple user IDs, each separated by a comma.


Example

To search for the profile of a user with the user ID 9bf4efz0-8j0y-1028-8b5a-xc07163b51b2, send the following HTTP request:

> GET /profiles/atom/profile.do?userid=9bf4efz0-8j0y-1028-8b5a-xc07163b51b2 
HTTP/1.1
> Authorization: ...
> Host: profiles.enterprise.example.com:9080
> Accept: */*

The HTTP response would look as follows:

< HTTP/1.1 200 OK
< Content-Type: application/atom+xml;charset=UTF-8
< Last-Modified: Thu, 07 Feb 2008 17:02:21 GMT
< Cache-Control: proxy-revalidate, must-revalidate, public, no-cache=set-cookie
< Content-Language: en-US
< Set-Cookie: JSESSIONID=0000sG4bN5ZLF1XfhXdOrE5dBp6:-1; Path=/
< Transfer-Encoding: chunked
< Date: Thu, 07 Feb 2008 17:13:59 GMT
< Server: WAS/6.1
< Expires: Thu, 01 Dec 1994 16:00:00 GMT

The following content is returned by the server:

<?xml version="1.0" encoding="UTF-8"?>
<feed 
 xmlns:app="http://www.w3.org/2007/app" 
 xmlns:fh="http://purl.org/syndication/history/1.0" 
 xmlns:thr="http://purl.org/syndication/thread/1.0" 
 xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
 xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" 
 xmlns="http://www.w3.org/2005/Atom">
  <id>tag:profiles.ibm.com,2006:feed</id>
  <generator version="3.0" uri="http://www.ibm.com/xmlns/prod/sn">
    IBM Connections - Profiles
  </generator>
  <title type="text">profile with userid 50730340-0101-102e-88e1-f78755f7e0ed</title>
  <author>
    <name>IBM Connections - Profiles</name>
  </author>
  <updated>2010-06-04T17:27:21.655Z</updated>
  <fh:complete></fh:complete>
  <link 
   href="https://profiles.enterprise.example.com/profiles/atom/profileTags.do?targetKey=
    f45c57c0-4165-43a4-94ba-cf35034074dc&amp;lastMod=1275588983010" 
   rel="http://www.ibm.com/xmlns/prod/sn/tag-cloud" 
   type="application/atomcat+xml">
  </link>
  <link 
   href="https://profiles.enterprise.example.com/profiles/atom/mv/theboard/entries.do?key=
    f45c57c0-4165-43a4-94ba-cf35034074dc&amp;lastMod=1275588983010" 
   rel="http://www.ibm.com/xmlns/prod/sn/mv/theboard" 
   type="application/atom+xml">
  </link>
  <link 
   href="https://profiles.enterprise.example.com/profiles/atom/mv/theboard/entry/status.do?
    key=f45c57c0-4165-43a4-94ba-cf35034074dc" 
   rel="http://www.ibm.com/xmlns/prod/sn/status" 
   type="application/atom+xml">
  </link>
  <link 
   href="https://profiles.enterprise.example.com/profiles/atom/connections.do?connectionType=
    colleague&amp;key=f45c57c0-4165-43a4-94ba-cf35034074dc&amp;lastMod=1275588983010" 
   rel="http://www.ibm.com/xmlns/prod/sn/connections/colleague" 
   type="application/atom+xml">
  </link>
  <link 
   href="https://profiles.enterprise.example.com/profiles/atom/reportingChain.do?key=
    f45c57c0-4165-43a4-94ba-cf35034074dc" 
   rel="http://www.ibm.com/xmlns/prod/sn/reporting-chain" 
   type="application/atom+xml">
  </link>
  <link 
   href="https://profiles.enterprise.example.com/profiles/atom/profileExtension.do?key=
    f45c57c0-4165-43a4-94ba-cf35034074dc&amp;extensionId=profileLinks&amp;lastMod=
    1275588983010" 
   rel="http://www.ibm.com/xmlns/prod/sn/ext-attr" 
   type="text/xml" 
   snx:extensionId="profileLinks" 
   xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
  </link>
  <link 
   href="https://profiles.enterprise.example.com/profiles/atom/profile.do?userid=
    50730340-0101-102e-88e1-f78755f7e0ed" 
   rel="self" 
   type="application/atom+xml">
  </link>
  <entry>
    <id>tag:profiles.ibm.com,2006:entryf45c57c0-4165-43a4-94ba-cf35034074dc</id>
    <title type="text">Sam Smith</title>
    <updated>2010-06-03T18:16:23.010Z</updated>
    <category term="profile" scheme="http://www.ibm.com/xmlns/prod/sn/type"></category>
    <contributor>
      <name>Sam Smith</name>
      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>
      <email>sSmith@example.com</email>
      <snx:userState>active</snx:userState>
    </contributor>
    <link 
     href="https://profiles.enterprise.example.com/profiles/atom/profileEntry.do?key=
      f45c57c0-4165-43a4-94ba-cf35034074dc" 
     rel="self" 
     type="application/atom+xml">
    </link>
    <link 
     href="https://profiles.enterprise.example.com/profiles/html/profileView.do?key=
      f45c57c0-4165-43a4-94ba-cf35034074dc" 
     rel="related" 
     type="text/html">
    </link>
    <link 
     href="https://profiles.enterprise.example.com/profiles/photo.do?key=
      f45c57c0-4165-43a4-94ba-cf35034074dc&amp;lastMod=1275588983010" 
     rel="http://www.ibm.com/xmlns/prod/sn/image" 
     type="image">
    </link>
    <link 
     href="https://profiles.enterprise.example.com/profiles/audio.do?
      key=f45c57c0-4165-43a4-94ba-cf35034074dc&amp;lastMod=1275588983010" 
     rel="http://www.ibm.com/xmlns/prod/sn/pronunciation" 
     type="audio">
    </link>
    <link 
     href="https://profiles.enterprise.example.com/profiles/vcard/profile.do?key=
      f45c57c0-4165-43a4-94ba-cf35034074dc" 
     rel="alternate" 
     type="text/directory">
    </link>
    <summary type="text">Profile information for Sam Smith</summary>
    <content type="xhtml">
      <sp_0:div 
       xmlns="http://www.w3.org/1999/xhtml" 
       xmlns:sp_0="http://www.w3.org/1999/xhtml">
        <span class="vcard">
          <div>
            <img 
             src="https://profiles.enterprise.example.com/profiles/photo.do?key=
              f45c57c0-4165-43a4-94ba-cf35034074dc&amp;lastMod=1275588983010" 
             class="photo">
            </img>
          </div>
          <div>
            <a 
             class="fn url" 
             href="https://profiles.enterprise.example.com/profiles/atom/profile.do?key=
              f45c57c0-4165-43a4-94ba-cf35034074dc">
              Sam Smith
            </a>
          </div>
          <div>
            <a 
             class="sound url" 
             href="https://profiles.enterprise.example.com/profiles/audio.do?key=
             f45c57c0-4165-43a4-94ba-cf35034074dc&amp;lastMod=1275588983010">
              Pronunciation
            </a>
          </div>
          <div>
            <a class="email" href="mailto:sSmith@example.com">
              sSmith@example.com
            </a>
          </div>
          <div class="x-groupwareMail" style="display:none">
          </div>
          <div class="org">
            <span class="organization-unit">
              Example Corp. Software Group
            </span>
          </div>
          <div class="role">Example Corp. Employee</div>
          <div class="title">guru</div>
          <div class="adr work postal">
          <div class="x-country-code" style="display:none">us</div>
        </div>
        <div class="x-office">
          <span class="x-building">test1</span>
          <span class="x-floor"></span>
          <span class="x-office-number"></span>
        </div>
        <div class="tel">
          <abbr class="type" title="work">Work:</abbr>
          <span class="value"></span>
        </div>
        <div class="x-manager-uid" style="display:none">
          Jane Doe
        </div>
          <div class="x-is-manager" style="display:none">N</div>
          <div class="x-profile-key">f45c57c0-4165-43a4-94ba-cf35034074dc</div>
          <div class="uid">50730340-0101-102e-88e1-f78755f7e0ed</div>
          <div class="x-profile-uid">Sam Smith</div>
          <div class="x-lconn-userid">50730340-0101-102e-88e1-f78755f7e0ed</div>
          <div class="rev" style="display:none">2010-06-03T18:16:23.010Z</div>
          <div class="x-profile-type" style="display:none">default</div>
        </span>
      </sp_0:div>
    </content>
  </entry>
</feed>


Parent topic

Getting Profiles feeds

Related reference
Retrieve profile extension data
Update profile extension data
Delete profile extension data
Retrieve a profile entry
Update profile entries
Profile entry content


   

 

});

+

Search Tips   |   Advanced Search