Get a list of your connections by status 

Returns a feed that lists invitations to connect by status. You can use this feed to see all of your pending invitations, unconfirmed invitations, and accepted invitations.

Table 1. Atom API request details

Resource Description
/atom/connections.do?connectionType=colleague&status=<status> Retrieves a list of invitations by status for the person whose credentials are provided with the request.

See Authenticating requests for information about how to authenticate the request.

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

Table 2. Input parameters

Parameter Description
connectionType

Note: Required.

Identifies the type of connection to look for. You must specify connectionType=colleague.
email 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: 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 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.

inclMessage 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, be the source of the connection object and authenticate the request.
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 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.

outputType Specifies the format in which the information is returned. Options are:
connection

    Returns colleague connection entries.

profile

since 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 Specifies the order in which to sort the results. Options are:
displayName

    Sorts the results by the person's display name.

lastMod

    Sorts the results by the last modified connection.

sortOrder Specifies the order in which to sort the results. Options are:
asc

    Ascending. This value is the default option.

desc

    Descending.

status Specifies the status of the invitation. Options are:
accepted

    Lists the connections that the person was invited to participate in and has accepted.

pending

    Lists the connections that the person was invited to participate in, but has not responded to yet.

      Note: You must authenticate the request when you specify this status value.

unconfirmed

    Lists the connections that the person has invited others to participate in, but that have not yet been accepted or deleted.

      Note: You must authenticate the request when you specify this status value.

userid 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: Provide either this parameter or the email parameter.


Parent topic

Getting Profiles feeds

Related reference
Colleague connection entry content


   

 

Submitted by Phillip Denton on Jan 31, 2012 3:50:52 PM

Re: Getting a list of your connections by status

Submitted by Phillip Denton on Jan 31, 2012 3:50:49 PM

Re: Getting a list of your connections by status

Is there a way to change the itemsPerPage or a flag to return all entries?

});