Retrieve the Colleagues In Common feed to find out what colleagues two people have in common.
The feed contains entries that represent colleague connections. Each entry contains the following information:
- A colleague that the two people share in common
- The status of the connection
You can choose how the output is displayed: as a connection entry or as a profile entry.
Table 1. Atom API request details
Retrieves a list of colleagues that two people share in common.
Use one or more input parameters to narrow the search. Separate multiple parameters with an ampersand (&).
Table 2. Input parameters
Identifies the type of connection to look for. You must specify connectionType=colleague.
Internet email addresses of the two people for whom you want to find common colleagues. Separate the two email addresses with a comma (,).
Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:
You must provide either this parameter or the userid parameter. Do not provide this parameter if Lotus® Connections is configured to prevent email addresses from being displayed. It will return an error code. Use the key or userid parameters instead.
Specifies whether you want a full profile or partial profile to be returned. Options are lite or full. The default value is lite.
Note: This can only be used when the outputType parameter is provided also and is set to profile.
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.
Specifies the output format option of the ATOM <content> element when the value of the outputType parameter is set to profile. Options are:
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.
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.
Specifies the format in which the information is returned. Options are:
Returns colleague connection entries.
Returns profile entries.
Includes in the resulting feed all colleague relationships established after a specified date. Specify the date using a date-time value that conforms to http://www.ietf.org/rfc/rfc3339.txt
">RFC3339. Use an upper case "T" to separate the date and time, and an uppercase "Z" in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z
Specifies the order in which to sort the results. By default, they are unordered. You can specify the following option:
Sorts the results by the person's display name.
Specifies the order in which to sort the results. Options are:
Ascending. This value is the default option.
The unique IDs that represent the two people for whom you want to find common colleagues. Separate the two IDs with a comma (,). To determine a person's user ID, you can search all profiles for the person by name. The feed that is returned identifies the person's user ID in the <snx:userid> element.
Note: You must provide either this parameter or the email parameter.
Parent topic: Getting Profiles feeds
Colleague connection entry content