Searching for a person's report-to chain

Search for a person's report-to chain

Retrieve the profiles of the people who comprise a specific user's report-to chain. For example, the profile of the user's manager, that manager's manager, and so on.

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/reportingChain.do	Retrieves the profiles of the people who comprise a user's report-to chain.

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 report-to chain you are interested in. 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.
format	Specifies whether you want a full profile or partial profile to be returned. Options are lite or full. The default value is lite.
inclUserStatus	Indicates whether or not to include the status message from the message board of each colleague represented in the returned feed. This parameter accepts the values of true or false.
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 each 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.

Example

To get the profiles of the people in the report-to chain of a person with the user ID 9bf4efz0-8j0y-1028-8b5a-xc07163b51b2, send the following HTTP request:

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

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.example.com,2006:feed</id> 
  <generator 
   version="2.0" 
   uri="http://www.ibm.com/xmlns/prod/sn">IBM Connections - Profiles
  </generator> 
  <title type="text">reporting chain for mary_lou@us.example.com</title> 
  <author>
    <name>IBM Connections - Profiles</name> 
  </author>
  <updated>2008-05-19T17:43:53.593Z</updated> 
  <fh:complete xmlns:fh="http://purl.org/syndication/history/1.0" /> 
  <link 
   href="https://profiles.enterprise.example.com:9443/profiles/atom/
    reportingChain.do?userid=9bf4efz0-8j0y-1028-8b5a-xc07163b51b2" 
   rel="self" 
   type="application/atom+xml" /> 
  <entry>
    <id>tag:profiles.example.com,2006:entryb559403a-9r32-2c81-c99w-ppq8bb69442j</id> 
    <category term="profile" scheme="http://www.ibm.com/xmlns/prod/sn/type" /> 
    <title type="text">Mary Lou</title> 
    <updated>2008-03-04T20:31:35.516Z</updated> 
    <contributor>
      <name>Mary Lou</name> 
      <email>mary_lou@us.example.com</email> 
      <snx:userid>9bf4efz0-8j0y-1028-8b5a-xc07163b51b2</snx:userid>
    </contributor>
    <link 
     href="https://profiles.enterprise.example.com/profiles/html/profileView.do?
      key=b559403a-9r32-2c81-c99w-ppq8bb69442j" 
     rel="related" 
     type="text/html" /> 
    <link 
     href="https://profiles.enterprise.example.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.example.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.example.com/profiles/vcard/profile.do?
      key=b559403a-9r32-2c81-c99w-ppq8bb69442j" 
     rel="alternate" 
     type="text/directory" /> 
    <in-reply-to xmlns="http://purl.org/syndication/thread/1.0">
      <accept xmlns="http://www.w3.org/2007/app">ref</accept> 
      <accept xmlns="http://www.w3.org/2007/app">
        tag:profiles.example.com,2006:entryL08061897
      </accept> 
    </in-reply-to>
    <summary type="text">Profile information for Mary Lou</summary> 
    <content type="xhtml">
      <div xmlns="http://www.w3.org/1999/xhtml">
        <span class="vcard">
          <div>
            <img 
             src="https://profiles.enterprise.example.com/profiles/photo.do?
              key=b559403a-9r32-2c81-c99w-ppq8bb69442j&lastMod=1204662695516" 
             class="photo" /> 
          </div>
          <div>
            <a 
             class="fn url" 
             href="https://profiles.enterprise.example.com/profiles/atom/
              profile.do?key=b559403a-9r32-2c81-c99w-ppq8bb69442j">
               Mary Lou
            </a> 
          </div>
          <div>
            <a 
             class="sound url" 
             href="https://profiles.enterprise.example.com/profiles/audio.do?
              key=b559403a-9r32-2c81-c99w-ppq8bb69442j&lastMod=1204662695516">
               Pronunciation
            </a> 
          </div>
          <div>
            <a 
             class="email" 
             href="mailto:mary_lou@us.example.com">
              mary_lou@us.example.com
            </a> 
          </div>
          <div 
           class="x-groupwareMail" 
           style="display:none">
            Mary Lou/Plainville/Acme
          </div> 
          <div class="org">
            <span class="organization-unit">Acme Sales, 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">Plainville</span> 
            <span class="region">NY</span> 
            <span class="postal-code">10123</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">ST</div> 
          </div>
          <div class="x-office">
            <span class="x-building">003998</span> 
            <span class="x-floor">NA</span> 
            <span class="x-office-number">J45</span> 
          </div>
          <div class="tel">
            <abbr class="type" title="work">Work:</abbr> 
            <span class="value">1-617-555-7817</span> 
          </div>
          <div class="x-manager-uid" style="display:none">0544632165</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">675998f0-5j8k-2234-1o44-tr37910t33k21d3</div> 
          <div class="x-profile-uid">789993281</div> 
          <div class="rev" style="display:none">2008-03-04T20:31:35.516Z</div> 
        </span>
      </div>
    </content>
  </entry>
  <entry>
    <id>tag:profiles.example.com,2006:entryh9r25784-543l-669s-65445-lwwk9tq4p234</id> 
    <category term="profile" scheme="http://www.ibm.com/xmlns/prod/sn/type" /> 
    <title type="text">Jane Doe</title> 
    <updated>2008-02-15T17:52:29.406Z</updated> 
    <contributor>
      <name>Jane Doe</name> 
      <email>jane_doe@us.example.com</email>
      <snx:userid>9bf4efz0-8j0y-1028-8b5a-db08553b51b2</snx:userid> 
    </contributor>
    <link 
     href="https://profiles.enterprise.example.com/profiles/html/profileView.do?
      key=9bf4efz0-8j0y-1028-8b5a-db08553b51b2" 
     rel="related" 
     type="text/html" /> 
    <link 
     href="https://profiles.enterprise.example.com/profiles/photo.do?
      key=9bf4efz0-8j0y-1028-8b5a-db08553b51b2&lastMod=1203097949406" 
     rel="http://www.ibm.com/xmlns/prod/sn/image" 
     type="image" /> 
    <link 
     href="https://profiles.enterprise.example.com/profiles/audio.do?
      key=9bf4efz0-8j0y-1028-8b5a-db08553b51b2&lastMod=1203097949406" 
     rel="http://www.ibm.com/xmlns/prod/sn/pronunciation" 
     type="audio" /> 
    <link 
     href="https://profiles.enterprise.example.com/profiles/vcard/profile.do?
      key=9bf4efz0-8j0y-1028-8b5a-db08553b51b2" 
     rel="alternate" 
     type="text/directory" /> 
    <in-reply-to xmlns="http://purl.org/syndication/thread/1.0">
      <accept xmlns="http://www.w3.org/2007/app">ref</accept> 
      <accept xmlns="http://www.w3.org/2007/app">
        tag:profiles.example.com,2006:entry049360897
      </accept> 
    </in-reply-to>
    <summary type="text">Profile information for Jane Doe</summary> 
    <content type="xhtml">
      <div xmlns="http://www.w3.org/1999/xhtml">
        <span class="vcard">
          <div>
            <img 
             src="https://profiles.enterprise.example.com/profiles/photo.do?
              key=9bf4efz0-8j0y-1028-8b5a-db08553b51b2&lastMod=1203097949406" 
             class="photo" /> 
          </div>
          <div>
            <a 
             class="fn url" 
             href="https://profiles.enterprise.example.com/profiles/atom/
              profile.do?key=9bf4efz0-8j0y-1028-8b5a-db08553b51b2">
               Jane Doe
            </a> 
          </div>
          <div>
            <a 
             class="sound url" 
             href="https://profiles.enterprise.example.com/profiles/audio.do?
              key=9bf4efz0-8j0y-1028-8b5a-db08553b51b2&lastMod=1203097949406">
               Pronunciation
            </a> 
          </div>
          <div>
            <a 
             class="email" 
             href="mailto:jane_doe@us.example.com">
              jane_doe@us.example.com
            </a> 
          </div>
          <div 
           class="x-groupwareMail" 
           style="display:none">
            Jane Doe/Plainville/Acme
          </div> 
          <div class="org">
            <span class="organization-unit">Acme Sales, NW</span> 
          </div>
          <div class="role">Acme employee, Regular</div> 
          <div class="title">Sales Manager</div> 
          <div class="adr work postal">
            <div class="street-address">5 Main St.</div> 
            <div class="extended-address x-streetAddress2" /> 
            <span class="locality">Plainville</span> 
            <span class="region">NY</span> 
            <span class="postal-code">10123</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">PV3</div> 
          </div>
          <div class="x-office">
            <span class="x-building">PV3</span> 
            <span class="x-floor">3</span> 
            <span class="x-office-number">3501</span> 
          </div>
          <div class="tel">
            <abbr class="type" title="work">Work:</abbr> 
            <span class="value">1-781-555-3402</span> 
          </div>
          <div class="x-manager-uid" style="display:none">049360897</div> 
          <div class="x-is-manager" style="display:none">Y</div> 
          <div class="x-profile-key">9bf4efz0-8j0y-1028-8b5a-db08553b51b2</div> 
          <div class="uid">994436g0-9f2w-6678-3312-pp04598l86f3</div> 
          <div class="x-profile-uid">89u709872345</div> 
          <div class="rev" style="display:none">2008-02-15T17:52:29.406Z</div> 
        </span>
      </div>
    </content>
  </entry>
  ...
</feed>

Parent topic

Getting Profiles feeds

Related reference
Profile entry content

});