Searching for a user's profile

Home

Searching 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. To retrieve an Atom entry document, see Retrieving a profile entry. The content element of each returned entry includes the vcard information for the person being represented by the entry.

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 (&).
Input parameters
Parameter Description
email
Internet e-mail 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 e-mail 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
Do not use this parameter if Lotus Connections is configured to prevent e-mail 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 full.
key An ID generated by Profiles to identify a person.
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.acme.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: WebSphere Application Server/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="http://www.w3.org/2005/Atom">
  <id>tag:profiles.ibm.com,2006:feed</id> 
  <generator 
   version="2.0" 
   uri="http://www.ibm.com/xmlns/prod/sn">
    Lotus Connections - Profiles
  </generator> 
  <title type="text">profile with email Amy_Jones11@us.acme.com</title> 
  <author>
    <name>Lotus Connections - Profiles</name> 
  </author>
  <updated>2008-05-20T21:13:38.609Z</updated> 
  <fh:complete xmlns:fh="http://purl.org/syndication/history/1.0" /> 
  <link 
   href="https://profiles.enterprise.acme.com/profiles/atom/profileTags.do?
    targetKey=b559403a-9r32-2c81-c99w-ppq8bb69442j&lastMod=1204662695516" 
   rel="http://www.ibm.com/xmlns/prod/sn/tag-cloud" 
   type="application/atomcat+xml" /> 
  <link 
   href="https://profiles.enterprise.acme.com/profiles/atom/colleagues.do?
    key=b559403a-9r32-2c81-c99w-ppq8bb69442j&lastMod=1204662695516" 
   rel="http://www.ibm.com/xmlns/prod/sn/colleagues" 
   type="application/atom+xml" /> 
  <link  
   href="https://profiles.enterprise.acme.com/profiles/atom/
    profileExtension.do?key=b559403a-9r32-2c81-c99w-ppq8bb69442j&extensionId=
    profileLinks&lastMod=1204662695516" 
   rel="http://www.ibm.com/xmlns/prod/sn/ext-attr" 
   type="text/xml" 
   xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
   snx:extensionId="profileLinks" /> 
  <link 
   href="https://profiles.enterprise.acme.com/profiles/atom/
    profileExtension.do?key=b559403a-9r32-2c81-c99w-ppq8bb69442j&extensionId=
    property1&lastMod=1204662695516" 
   rel="http://www.ibm.com/xmlns/prod/sn/ext-attr" 
   type="text/plain" 
   xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
   snx:extensionId="property1" /> 
  <link 
   href="https://profiles.enterprise.acme.com/profiles/atom/profile.do?
    email=Amy_Jones11%40us.acme.com" 
   rel="self" 
   type="application/atom+xml" /> 
  <entry>
    <id>tag:profiles.ibm.com,2006:entryb559403a-9r32-2c81-c99w-ppq8bb69442j</id> 
    <category term="profile" scheme="http://www.ibm.com/xmlns/prod/sn/type" /> 
    <title type="text">Amy Jones</title> 
    <updated>2008-03-04T20:31:35.516Z</updated> 
    <link 
     href="https://profiles.enterprise.acme.com/profiles/atom/
      profileEntry.do?key=b559403a-9r32-2c81-c99w-ppq8bb69442j" 
     rel="self" 
     type="application/atom+xml" /> 
    <link 
     href="https://profiles.enterprise.acme.com/profiles/html/profileView.do?
      key=b559403a-9r32-2c81-c99w-ppq8bb69442j" 
     rel="related" 
     type="text/html" /> 
    <link 
     href="https://profiles.enterprise.acme.com/profiles/photo.do?key=
      b559403a-9r32-2c81-c99w-ppq8bb69442j&lastMod=1204662695516" 
     rel="http://www.ibm.com/xmlns/prod/sn/image" 
     type="image" /> 
    <link 
     href="https://profiles.enterprise.acme.com/profiles/audio.do?
      key=b559403a-9r32-2c81-c99w-ppq8bb69442j&lastMod=1204662695516" 
     rel="http://www.ibm.com/xmlns/prod/sn/pronunciation" 
     type="audio" /> 
    <link 
     href="https://profiles.enterprise.acme.com/profiles/vcard/profile.do?
      key=b559403a-9r32-2c81-c99w-ppq8bb69442j" 
     rel="alternate" 
     type="text/directory" /> 
    <summary type="text">Profile information for Amy Jones</summary> 
    <content type="xhtml">
      <div xmlns="http://www.w3.org/1999/xhtml"> 
        <span class="vcard">
          <div>
            <img 
             src="https://profiles.enterprise.acme.com/profiles/photo.do?
              key=b559403a-9r32-2c81-c99w-ppq8bb69442j&lastMod=1204662695516" 
             class="photo" /> 
          </div>
          <div>
            <a 
             class="fn url" 
             href="https://profiles.enterprise.acme.com/profiles/atom/
              profile.do?key=b559403a-9r32-2c81-c99w-ppq8bb69442j">
               Amy Jones
            </a> 
          </div>
          <div>
            <a 
             class="sound url" 
             href="https://profiles.enterprise.acme.com/profiles/audio.do?
              key=b559403a-9r32-2c81-c99w-ppq8bb69442j&lastMod=1204662695516">
               Pronunciation
            </a> 
          </div>
          <div>
            <a 
             class="email" 
             href="mailto:Amy_Jones11@us.acme.com">
              Amy_Jones11@us.acme.com
            </a> 
          </div>
          <div 
           class="x-groupwareMail" 
           style="display:none">
            Amy Jones/Plainville/IBM
          </div> 
          <div class="org">
            <span class="organization-unit">Acme Sales Group, NW</span> 
          </div>
          <div class="role">Acme employee, Regular</div> 
          <div class="title">Sales Representative</div> 
          <div class="adr work postal">
            <div class="street-address">5 Main St</div> 
            <div class="extended-address x-streetAddress2" /> 
            <span class="locality">NEW YORK</span> 
            <span class="region">NY</span> 
            <span class="postal-code">10234</span> 
            <div class="country-name">United States</div> 
            <div class="x-country-code" style="display:none">us</div> 
            <div class="x-worklocation-code" style="display:none">SNW</div> 
          </div>
          <div class="x-office">
            <span class="x-building">0Y79</span> 
            <span class="x-floor">NA</span> 
            <span class="x-office-number">5446</span> 
          </div>
          <div class="tel">
            <abbr class="type">Work:</abbr> 
            <span class="value">1-781-555-7817</span> 
          </div>
          <div class="x-manager-uid" style="display:none">L0859473021</div> 
          <div class="x-is-manager" style="display:none">N</div> 
          <div class="x-profile-key">b559403a-9r32-2c81-c99w-ppq8bb69442j</div> 
          <div class="uid">9589273g0-8f0a-8843-8a08-db09224b51b2</div> 
          <div class="x-profile-uid">43598270987</div> 
          <div class="rev" style="display:none">2008-03-04T20:31:35.516Z</div> 
        </span>
      </div>
    </content>
  </entry>
</feed>
Get Profiles feeds

Related reference

Retrieving profile extension data
Updating profile extension data
Delete profile extension data
Retrieving a profile entry
Updating profile entries
Profile entry content

+
Search Tips | Advanced Search

Parameter	Description
email	Internet e-mail 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 e-mail 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 Do not use this parameter if Lotus Connections is configured to prevent e-mail 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 full.
key	An ID generated by Profiles to identify a person. 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.