Community articleDeleting a colleague connection 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

To remove an existing colleague relationship, or to decline an invitation to become a colleague, use the HTTP DELETE method.



To remove an existing colleague relationship, or to decline an invitation to become a colleague, use the HTTP DELETE method.

Administrators may delete or decline connections on behalf of other users. Deleted connections cannot be restored.

Provide one parameter for the connection source and one parameter for the connection target. If source and target parameters are provided by the caller, parameters for delete all are not processed.

Parameters in this table are not processed if connectionId or source and target parameters are provided.

Input

None.

Output

None.

 

Input
Method URI Description
DELETE /profiles/admin/atom/connections.do To remove an existing colleague relationship, or to decline an invitation to become a colleague, use the HTTP DELETE method.
Content Type: application/atom+xml
Name Type Optional Description
connectionId
string Yes Specifies the unique identification string for the connection.
If this parameter is provided by the caller, no other parameters are processed.
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 returned feed identifies the person's user ID in the <snx:userid> element.
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.
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.
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 returned feed 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 as in the following:
adam_eventide%40garden.com
Note: Do not use if configured to prevent email addresses from being displayed. Doing so will return an error code 400 for an invalid request. Use the key or userid parameters instead.
souceEmail
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 as in the following:
adam_eventide%40garden.com
Note: Do not use if configured to prevent email addresses from being displayed. Doing so will return an error code 400 for an invalid request. Use the key or userid parameters instead.
email
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 as in the following:
adam_eventide%40garden.com
Note: Do not use if configured to prevent email addresses from being displayed. Doing so will return an error code 400 for an invalid request. Use the key or userid parameters instead.
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.
404
Not Found