Community articleSearching for a person's colleagues
Added by IBM contributorIBM on April 3, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Returns a feed that lists the contacts that a person has designated as colleagues. You can use this resource to subscribe to a person's list of colleagues.



Returns a feed that lists the contacts that a person has designated as colleagues. You can use this resource to subscribe to a person's list of colleagues.

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

Input
Method URI Description
GET /profiles/atom/connections.do Retrieves information about who a person has designated as colleagues.
Name Type Optional Description
connectionType
string No Identifies the type of connection to look for. You must specify connectionType=colleague. Required.
email
string Yes Internet email address of the user whose colleagues you want to retrieve.
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: You must provide either this parameter or the userid parameter. Do not provide this parameter if IBM® Connections is configured to prevent email addresses from being displayed. It will return an error code. Use the key or userid parameters instead.
format
enumerated Yes 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.
Authorized values:
  • lite
  • full
inclMessage
boolean Yes Specifies whether or not to include the invitation message with the returned entries. This parameter accepts a Boolean value of true or false. If you include this parameter and set it to true, you must be the source of the connection object and you must authenticate the request.
inclUserStatus
boolean Yes 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
string Yes 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
enumerated Yes Specifies the output format option of the ATOM <content> element when the value of the outputType parameter is set to profile. 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.
Authorized values:
  • hcard
  • vcard
outputType
enumerated Yes Specifies the format in which the information is returned. Options are:
connection
Returns colleague connection entries.
profile
Returns profile entries.
Authorized values:
  • connection
  • profile
page
int Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps
int Yes Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 250.
since
string Yes Includes in the resulting feed all colleague relationships established after a specified date. Specify the date using a date-time value that conforms to 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.
sortBy
enumerated Yes Specifies the order in which to sort the results. By default, they are ordered by the date on which a person requested to connect to you. You can specify the following option:
displayName
Sorts the entries alphabetically by display name.
Authorized values:
  • displayName
  • modified
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
Sorts the results in ascending order.
desc
Sorts the results in descending order.
Authorized values:
  • asc
  • desc
userid
string Yes A unique ID that represents a specific person. 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.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.