Colleague connection entry content 

Lists the elements in a colleague connection Atom entry.

A colleague connection represents a two-way connection between two people. Each way is represented as a separate connection entry, so the list of connections for Sam contains a connection with source=Alice and target=Bob. Conversely, the list of connections for Bob contains the same connection with source=Bob and target=Alice. The person whose connections are being viewed is always identified as the source of the connection regardless of who initiated the connection.

All elements are in the http://www.w3.org/2005/Atom namespace, except those that are prefixed as follows:

snx

Table 1. Connection entry elements

Element How treated on input Description
<id> Ignored Unique identifier of a connection.
<title> Required Connection title.
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="connection"/> Required Identifies the Atom entry as a connection.
<category scheme="http://www.ibm.com/xmlns/prod/sn/connection/type" term="colleague"/> Required Identifies the connection type to be a colleague.
<category scheme="http://www.ibm.com/xmlns/prod/sn/status" term="pending"/> Required Identifies the status of the connection. Options are:
accepted

    The person was invited to be a colleague and accepted the invitation. Both participants in the connection see this status after an invitation has been accepted.

pending

    The person has been invited to be a colleague, but has not yet responded. Use this status to create an invitation.

unconfirmed

    The person has sent an invitation, but has not yet received a response.

<link rel="self" href="..." /> Ignored Use the address in the href attribute of this link to obtain an Atom entry document containing a complete representation of this connection. Operations are supported on the link address:

  • GET: Obtain a full representation of this connection as an Atom Entry document.

  • HEAD: Retrieve just HTTP headers to quickly find out the status of this connection.

<link rel="edit" type="application/atom+xml" href="edit_url" /> Ignored Use the address in the href attribute of this link to obtain an Atom entry document containing a complete representation of this connection topic. The following operations are supported on the link address:

  • GET: Obtain a full representation of this connection as an Atom Entry document

  • HEAD: Retrieve just HTTP headers to quickly find out the status of this connection.

  • PUT: Update this connection to change it's status

  • DELETE: Delete this connection. Deleting a connection also removes the corresponding connection from the other user to you.

<snx:connection> Required Identifies the participants in the connection. See Table 2 for more details.
<content type="html"> Required Contains the text of the colleague connection invitation. This is visible to the invited user only.

Note: If the content is larger than 2KB, then a <summary> element with the first 2KB of the content is included instead, and an enclosure link which points at the full content is provided.

<updated> Ignored The date the entry was last modified as defined in the Atom specification.
<author>
  <name>
  <email>
  <snx:userid>
  <snx:userState>
</author>

Ignored The person who created the connection by sending the invitation.
<contributor>
  <name>
  <email>
  <snx:userid>
  <snx:userState>
</contributor>

Ignored The contributor of this connection. This element provides general information about the contributor including userid and user state, which identifies whether the person is an active or inactive user. The data in the <contributor> element is ignored for update actions.

Table 2. The <snxconnection> element

Element How treated on input Description
<contributor snx:rel="http://www.ibm.com/xmlns/prod/sn/connection/source"> Ignored Contains information about the person whose connections are being viewed.
<contributor snx:rel="http://www.ibm.com/xmlns/prod/sn/connection/target"> Ignored Contains information about the other participant in the connection.


Note: The <author> element and each <contributor> element accepts the <name> element as specified in the Atom specification. They also accept the <snx:userid> element. If IBM Connections is configured to prevent email addresses from being displayed, then the <email> element is not supported. Otherwise, it can be used.

<?xml version="1.0" encoding="UTF-8" ?> 
<entry 
 xmlns="http://www.w3.org/2005/Atom" 
 xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
  <id>tag:profiles.ibm.com,2006:entry85519b6a-e8c4-4119-8570-592365f8d4j3</id> 
  <title type="text">Paul Dylan</title> 
  <updated>2008-06-17T07:18:42.101Z</updated> 
  <category 
   term="connection" scheme="http://www.ibm.com/xmlns/prod/sn/type" /> 
  <category 
   term="colleague" scheme="http://www.ibm.com/xmlns/prod/sn/connection/type" /> 
  <category 
   term="accepted" scheme="http://www.ibm.com/xmlns/prod/sn/status" /> 
  <author>
    <name>Sue Jones</name> 
    <userid 
     xmlns="http://www.ibm.com/xmlns/prod/sn">
      324ffc40-ca2d-102b-8791-de72de090cdf
    </userid> 
    <email>sue_jones@example.com</email> 
  </author>
  <contributor>
    <name>Sue Jones</name> 
    <userid 
     xmlns="http://www.ibm.com/xmlns/prod/sn">
      324ffc40-ca2d-102b-8791-de72de090jkf
    </userid> 
    <email>sue_jones@example.com</email> 
  </contributor>
  <snx:connection xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
    <contributor snx:rel="http://www.ibm.com/xmlns/prod/sn/connection/source">
      <name>Sue Jones</name> 
      <userid xmlns="http://www.ibm.com/xmlns/prod/sn">
       324ffc40-ca2d-102b-8791-de72de090jkf
      </userid> 
      <email>sue_jones@example.com</email> 
    </contributor>
    <contributor snx:rel="http://www.ibm.com/xmlns/prod/sn/connection/target">
      <name>Paul Dylan</name> 
      <userid xmlns="http://www.ibm.com/xmlns/prod/sn">
       4f47cdc0-93f3-102b-841e-82c8cf9644ae
      </userid> 
      <email>pdylan@example.com</email> 
    </contributor>
  </snx:connection>
  <content type="html" /> 
  <link 
   href="https://profiles.example.com/profiles/atom/connection.do?
    connectionId=85519b6a-e8c4-4119-8570-592365f8d4j3" 
   rel="self" 
   type="application/atom+xml" /> 
  <link 
   href="https://profiles.example.com/profiles/atom/connection.do? 
    connectionId=85519b6a-e8c4-4119-8570-592365f8d4j3" 
   rel="edit" 
   type="application/atom+xml" /> 
  <summary type="text" /> 
  </entry>


Parent topic

Profiles Atom entry types

Related reference
Inviting a person to become your colleague
Retrieve connections
Accept an invitation to become a colleague
Delete connections
Getting a list of your connections by status
Checking whether two people are colleagues
Find colleagues shared by two people


   

 

});

+

Search Tips   |   Advanced Search