Community articleCommunity member entry content
Added by IBM contributorIBM on June 23, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Lists the elements in a member Atom entry.
Tags: commapi



Lists the elements in a member Atom entry.

You can create member entries in the Activities, Communities, and Forums applications. Most elements of a member are the same for all services. The first table lists the common elements; the additional tables define extensions used by specific services.

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

snx

In the http://www.ibm.com/xmlns/prod/sn namespace.

Table 1. Member entry elements

Element
How treated on input
Description
<id>
Ignored
Unique identifier of a member entry.
<title type="text">
Ignored
Entry title; the full name of the user this member represents specified in text format. The type attribute is optional; type="text" is the default and only format allowed.
<contributor>

<name>

<email>

<snx:userid>

<snx:userState>

</contributor>
Required. See the tables below for additional notes where applicable.
Specifies the user that this member entry represents. You must provide either an <email> element or <snx:userid> element on input. If IBM® Connections is configured to prevent email addresses from being displayed, then the <email> element is not supported; provide the <snx:userid> instead. Otherwise, <email> can be used. The <name> and <snx:userState> elements are ignored on input.
<snx:role component="...">
See tables below
Each application can define roles for members of its resources. See the tables below for the roles defined by each application.
<link rel="edit" type="application/atom+xml" href="edit_url"/>
Ignored
Specifies a URI from which you can retrieve the full content of the member entry, as opposed to a summary. Use this URI to update or delete the member entry.

Activities Extensions

The following elements are supported for member entries in an activity in addition to the common elements defined in Table 1.

Table 2. Member entry elements specific to the Activities application

Element
How treated on input
Description
<contributor>

<name>

<email>

<snx:userid>

</contributor>
Required
Note: To specify that an activity is public, specify * as the value of the <email> or <snx:userid> element. For example:

<contributor>
<name></name>
<email>*</email>
<snx:userid></snx:userid>
</contributor>
<snx:role component="http://www.ibm.com/xmlns/prod/sn/activities">
Required
Specifies the member's role in the activity. Options are owner, member, and reader. The default value is member.

Note: The <snx:role> element must be present. If you do not provide a value for the element, the default value of member is applied to it.
If you are defining a public activity and used * as the value of the <email> or <userid> elements, then specifying reader here indicates that the public access activity is read-only.
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term=" " />
Optional
Specifies the member type. Options are person, group, and community.

Note: If you do not provide a category element, then the server creates one. If your activity is private, it sets the term attribute equal to person. If the activity is public, it sets the term attribute equal to group by default.

Communities Extensions

The following elements are supported for member entries in a community in addition to the common elements defined in Table 1.

Table 3. Member entry elements specific to the Communities application

Element
How treated on input
Description
<snx:role component="http://www.ibm.com/xmlns/prod/sn/communities">
Optional
Specifies the member's role in the community. Options are member and owner. The default value is member.
<snx:isExternal>false</snx:isExternal>

within

<contributor>

Ignored
Indicates whether a person member is an external user.

Forums Extensions

The following elements are supported for member entries in a forum in addition to the common elements defined in Table 1.

Table 4. Member entry elements specific to the Forums application

Element
How treated on input
Description
<snx:role component="http://www.ibm.com/xmlns/prod/sn/forums">
Required
Specifies the member's role in the forum. Options are owner and moderator. Forums only uses the member entries to control owner and moderator access.