Community articleFollowing a person using the Administration API
Added by IBM contributorIBM | Edited by IBM contributorLDD Webmaster on July 1, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Profiles administrators can create following relationships between people. To create a relationship, use the HTTP PUT method.



Profiles administrators can create following relationships between people. To create a relationship, use the HTTP PUT method.

 

The caller must specify parameters to identify the following relationship. The source user is the follower, the target user is the person being followed. Provide one source and one target parameter.

Input

None.

Output

None.

 

 

Input
Method URI Description
PUT /profiles/admin/atom/following.do Profiles administrators can create following relationships between people. To create a relationship, use the HTTP PUT method.
Content Type: application/atom+xml
Sample Request:
<person xmlns="http://ns.opensocial.org/2008/opensocial" />
Name Type Optional Description
action
string Yes action=follow
sourceEmail
string Yes Internet email address of the user. Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40.
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.
sourceKey
string No 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.
sourceUserid
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.
targetEmail
string Yes Internet email address of the user. Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40.
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.
targetKey
string No 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.
targetUserid
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.
Output
Code Description
200
OK. Indicates that the request was received successfully.
400
Bad Request. Returned when no matching user record can be found.
403
Forbidden. The server refuses to fulfill a request, typically because the request was for an object that you don't have permission to access.