Home

 

Searching Profiles

Search for a set of profiles that match a specific criteria and return them in a feed. You can use this resource to discover someone's user ID. When you search by name, the returned feed identifies each person's user ID, which you can subsequently use in other types of searches to retrieve more detailed information about a person.

This method returns a feed of profiles as opposed to retrieving the Atom entry of a single 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/search.do	Retrieves profiles that match a specific search criteria.

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

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.

Input parameters

Parameter	Description
city	City. Returns all profiles that contain a matching city value.
country	Country. Returns all profiles that contain a matching country value.
email	Internet e-mail address. Returns all profiles that contain a matching e-mail address.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.
format	Specifies whether you want a full profile or partial profile to be returned. Options are lite or full. The default value is full.
jobTitle	Job title. Returns all profiles that contain a matching job title value.
name	Name. Returns all profiles that contain a matching name value. You can specify a first name or last name.
organization	Organization. Returns all profiles that contain a matching organization value.
page	Page number. Specifies the page to be returned. Default is 1.
phoneNumber	Phone number. Returns all profiles that contain a matching phone number.
profileTags	Returns profiles with the specified tags. Separate multiple tags with a comma. If you use a comma, it must be URL-encoded as %2C.
profileType	Specifies the type of profile. The types are defined by you in the Profiles database. See Adding Profile Types for more information.
ps	Page size. Specifies the number of entries to return per page.
search	Well-formed full text search query. Performs a text search of the Profile Tags, About Me, and Background fields of all the profiles.
state	State. Returns all profiles that contain a matching state value.
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.

 

Example

To search for the profile of every person with a city value of Westford in their profiles, send the following HTTP request:

> GET /profiles/atom/search.do?city=Westford HTTP/1.1
> Authorization: Basic ...
> 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
< Content-Language: en-US
< Set-Cookie: JSESSIONID=0000zCzC9OEwpsJujoEevd_IBlK:-1; Path=/
< Transfer-Encoding: chunked
< Date: Thu, 07 Feb 2008 18:06:40 GMT
< Server: WebSphere Application Server/6.1
< Expires: Thu, 01 Dec 1994 16:00:00 GMT
< Cache-Control: no-cache="set-cookie, set-cookie2"

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.5" uri="http://www.ibm.com/xmlns/prod/sn">
   Lotus Connections - Profiles
  </generator>
  <title type="text">profiles where city=Westford</title>
  <author><name>Lotus Connections - Profiles</name></author>
  <updated>2009-03-18T18:55:38.062Z</updated>
  <opensearch:totalResults 
   xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
    250
  </opensearch:totalResults>
  <opensearch:startIndex 
   xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
    1
  </opensearch:startIndex>
  <opensearch:itemsPerPage 
   xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
    10
  </opensearch:itemsPerPage>
  <link 
   href="https://profiles.enterprise.acme.com:9447/profiles/atom/search.do?
   city=Westford&amp;page=2&amp;ps=10" rel="next">
  </link>
  <link 
   href="https://profiles.enterprise.acme.com:9447/profiles/atom/search.do?
   city=Westford&amp;page=25&amp;ps=10" rel="last">
  </link>
  <link 
   href="https://profiles.enterprise.acme.com:9447/profiles/atom/search.do?
   city=Westford" rel="self" type="application/atom+xml">
  </link>
  <entry>
    <id>tag:profiles.ibm.com,2006:entry130114ab-d54c-4d04-b307-0e6ff2bee8ec</id>
    <title type="text">Amy Jones1</title>
    <updated>2009-03-18T08:12:47.171Z</updated>
    <category 
     term="profile" 
     scheme="http://www.ibm.com/xmlns/prod/sn/type">
    </category>
    <contributor>
      <name>Amy Jones1</name>
      <userid xmlns="http://www.ibm.com/xmlns/prod/sn">
       5adff8c0-7d67-102c-8452-e2ebc3ec5536
      </userid>
      <email>ajones1@us.acme.com</email>
    </contributor>
    <link 
     href="https://profiles.enterprise.acme.com:9447/profiles/atom/profile.do?
           key=130114ab-d54c-4d04-b307-0e6ff2bee8ec" 
     rel="self" 
     type="application/atom+xml">
    </link>
    <link 
     href="https://profiles.enterprise.acme.com:9447/profiles/html/profileView.do?
           key=130114ab-d54c-4d04-b307-0e6ff2bee8ec" 
     rel="related" 
     type="text/html">
    </link>
    <link 
     href="https://profiles.enterprise.acme.com:9447/profiles/photo.do?
           key=130114ab-d54c-4d04-b307-0e6ff2bee8ec&amp;lastMod=1237363967171" 
     rel="http://www.ibm.com/xmlns/prod/sn/image" 
     type="image"></link>
    <link 
     href="https://profiles.enterprise.acme.com:9447/profiles/audio.do?
           key=130114ab-d54c-4d04-b307-0e6ff2bee8ec&amp;lastMod=1237363967171"
     rel="http://www.ibm.com/xmlns/prod/sn/pronunciation" 
     type="audio">
    </link>
    <link 
     href="https://profiles.enterprise.acme.com:9447/profiles/vcard/profile.do?
           key=130114ab-d54c-4d04-b307-0e6ff2bee8ec" 
     rel="alternate" 
     type="text/directory">
    </link>
    <summary type="text">Profile information for Amy Jones1</summary>
    <content type="xhtml">
      <div xmlns="http://www.w3.org/1999/xhtml">
        <span class="vcard">
          <div>
            <img 
             src="https://profiles.enterprise.acme.com:9447/profiles/photo.do?
                  key=130114ab-d54c-4d04-b307-0e6ff2bee8ec&amp;
                  lastMod=1237363967171" 
                 class="photo">
            </img>
          </div>
          <div>
            <a 
             class="fn url" 
             href="https://profiles.enterprise.acme.com:9447/profiles/atom/
                   profile.do?key=130114ab-d54c-4d04-b307-0e6ff2bee8ec">
              Amy Jones1
            </a>
          </div>
          <div>
            <a 
             class="sound url" 
             href="https://profiles.enterprise.acme.com:9447/profiles/audio.do?
                   key=130114ab-d54c-4d04-b307-0e6ff2bee8ec&amp;
                   lastMod=1237363967171">
               Pronunciation
            </a>
          </div>
          <div>
            <a 
             class="email" 
             href="mailto:ajones1@us.acme.com">
              ajones1@us.acme.com
            </a>
          </div>
          <div class="x-groupwareMail" style="display:none"></div>
          <div class="org">
           <span class="organization-unit"></span>
          </div>
          <div class="role">IBM Employee</div>
          <div class="title"></div>
          <div class="adr work postal">
          <div class="street-address">5 Technology Park Drive</div>
          <div class="extended-address x-streetAddress2"></div>
          <span class="locality">Westford</span>
          <span class="region">Massachusetts</span>
          <span class="postal-code">01886</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">WM</div>
        </div>
        <div class="x-office">
          <span class="x-building"></span>
          <span class="x-floor"></span>
          <span class="x-office-number"></span>
        </div>
        <div class="tel">
          <abbr class="type">Work:</abbr>
          <span class="value">1-978-399-0000</span>
        </div>
        <div class="x-manager-uid" style="display:none"></div>
        <div class="x-is-manager" style="display:none"></div>
        <div class="x-profile-key">130114ab-d54c-4d04-b307-0e6ff2bee8ec</div>
        <div class="uid">5adff8c0-7d67-102c-8452-e2ebc3ec5536</div>
        <div class="x-profile-uid">Amy Jones1</div>
        <div class="x-lconn-userid">5adff8c0-7d67-102c-8452-e2ebc3ec5536</div>
        <div class="rev" style="display:none">2009-03-18T08:12:47.171Z</div>
      </span>
    </div>
  </content>
</entry>

Get Profiles feeds

 

Related tasks

Get a person's user ID in Activities

Configure profile types for widget layout

 

Related reference

Profile entry content

---

+

Search Tips   |   Advanced Search