Search Profiles programmatically 

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 instead of the Atom entry of a single 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.

Table 1. 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 (&).

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

Table 2. Input parameters

Parameter Description
activeUsersOnly Specifies whether to include inactive users in the search. Options are true or false. The default value is true; searches do not include inactive users.
city Returns all profiles that contain a matching city value.
country Returns all profiles that contain a matching country value.
email Returns all profiles that contain a matching Internet email address.

Format the HTTP request using the correct URL encoding. For example, the encoded form of the at sign (@) is %40 as in:

adam_eventide%40example.com

Note: Do not use this parameter if IBM Connections is configured to prevent email addresses from being displayed because it returns 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 lite.
jobTitle Returns all profiles that contain a matching job title value.
name Returns all profiles that contain a matching name value. You can specify a first name or last name.
organization Returns all profiles that contain a matching organization value.
page Specifies the page number to be returned. The default is 1.
phoneNumber 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 Add 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 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.example.com:9080
> Accept: */*

HTTP response:

< HTTP/1.1 200 OK

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="3.0" uri="http://www.ibm.com/xmlns/prod/sn">
   IBM Connections - Profiles
  </generator>
  <title type="text">profiles where city=Westford</title>
  <author><name>IBM 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.example.com:9447/profiles/atom/search.do?
   city=Westford&amp;page=2&amp;ps=10" rel="next">
  </link>
  <link 
   href="https://profiles.enterprise.example.com:9447/profiles/atom/search.do?
   city=Westford&amp;page=25&amp;ps=10" rel="last">
  </link>
  <link 
   href="https://profiles.enterprise.example.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>
      <snx:userState>active</snx:userState>
      <email>ajones1@us.example.com</email>
    </contributor>
    <link 
     href="https://profiles.enterprise.example.com:9447/profiles/atom/profile.do?
           key=130114ab-d54c-4d04-b307-0e6ff2bee8ec" 
     rel="self" 
     type="application/atom+xml">
    </link>
    <link 
     href="https://profiles.enterprise.example.com:9447/profiles/html/profileView.do?
           key=130114ab-d54c-4d04-b307-0e6ff2bee8ec" 
     rel="related" 
     type="text/html">
    </link>
    <link 
     href="https://profiles.enterprise.example.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.example.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.example.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.example.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.example.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.example.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.example.com">
              ajones1@us.example.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" title="work">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>


Parent topic

Getting Profiles feeds


Related tasks


Getting a person's user ID in Activities
Configure profile types for widget layout

Related reference
Profile entry content


   

 

});