Invitation content 

Lists the elements in an Atom entry that represents an invitation to join a community.

All elements are in the http://www.w3.org/2005/Atom namespace.

Table 1. Invitation entry elements

Element How treated on input Description
<id> Ignored Unique identifier of the invitation.
<title> Required Title of the invitation.
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="invite"/> Required Identifies the Atom entry as a community invitation.
<link rel="self" href="..." /> Ignored Use the web address in the href attribute to obtain an Atom entry document containing a complete representation of this invitation. The following operation is supported:
GET

    Use the web address in the href attribute to obtain a full representation of this invitation as an Atom Entry document.

<link rel="edit" type="application/atom+xml" href="edit_url" /> Ignored Use the web address in the href attribute to obtain an Atom entry document containing a complete representation of this invitation. If you are an owner of the community, the following operations are supported on the link address:
GET

    Use the web address in the href attribute to obtain a full representation of this invitation as an Atom entry document.

POST

    Use the web address in the href attribute to create an invitation.

DELETE

    The invitee can use the web address in the href attribute to decline this invitation and the owner can use it to revoke the invitation.

<content type="text"> Ignored Content of the invitation; may be empty.
<updated> Ignored The date an entry was updated as defined in the Atom specification.
<author>
  <name>
  <email>
  <snx:userid>
  <snx:userState>
</author>

Ignored The person who sent out the invitation. 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.
<contributor>
  <name>
  <email>
  <snx:userid>
  <snx:userState>
</contributor>

Required

Note: You do not need to provide a value for the <snx:userState> child element, but identify the person by providing either the <email> or <snx:userid> element.

The person to whom the invitation was sent. 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.


Parent topic

Communities Atom entry types

Related reference
Create a community invitation programmatically
Retrieve an invitation
Declining or revoking an invitation


   

 

});