To invite a person to become your colleague, send an Atom entry document containing the connection resource to the person's colleague connections feed.
To find a person's colleague connections feed, you can search for the person by name. From the returned feed, find the person and retrieve her associated user ID, and then use the user ID to retrieve the person's full feed, which includes a link to her colleague connections feed.
After you send the invitation, the connection is added to your connections in an unconfirmed state. The connection is added to the connections of the person you invited in a pending state. See Accepting an invitation to become a colleague
or Deleting connections
for information about how to accept or decline an invitation.
See Authenticating requests
for information about how to authenticate the request.
Table 1. Atom API request details
|POST||colleague connections feed||Value of the href attribute of the <link> element with the rel="http://www.ibm.com/xmlns/prod/sn/connections/colleague" attribute value.|
Note: You must include the connectionType=colleague parameter with this request.
Provide a connection Atom entry document.
The content type of the Atom entry document must be application/atom+xml
An Atom entry document containing the new connection.
Returned HTTP headers
HTTP/1.1 201 Created
Indicates that the invitation to connect was successfully created. If an error occurs, this header will contain one of the error codes below.Location: url
Link to edit_url of the connection entry. You can use the web address specified here to subsequently retrieve and update the connection.Error codes
- HTTP/1.1 400 Bad Request
- HTTP/1.1 401 Unauthorized
To invite someone to become a colleague, you can send the following HTTP request:
Authorization: Basic xxxx
The example above is valid in a deployment where email addresses are exposed. In environments where email addresses are hidden, the colleague would likely be identified by the value of their <x-profile-key>. For example:
<?xml version="1.0" encoding="UTF-8"?>
<!-- Message to other user -->
Please accept this invitation to be in my network of Connections colleagues.
Parent topic: Working with colleague connections
Colleague connection entry content
HTTP/1.1 201 Created