Community event instance content
Added by IBM contributorIBM | Edited by Claudia R Elbourn on July 7, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Add and edit content for a community event instance
Tags: commapi

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. Event entry elements

Element
How treated on input
Description
<id>
Ignored
Unique identifier of a community event.
<title type="text">
Required
Entry title; a descriptive title of the event specified in text format. The type attribute is optional; type="text" is the default and only format allowed.
<link rel="edit" type="application/atom+xml" href="edit_url"/>
Ignored
If you are an owner of the event, use this web address to update or delete the event.
<link rel="alternate" type="text/html" href="xxxxxx"/>
Ignored
Use this web address to obtain a HTML representation of this event suitable for display in a browser.
<link rel="self" type="application/atom+xml" href="xxxxxx"/>
Ignored
Use the web address in the href attribute to return a complete representation of this event.
<link href="" rel="http://www.ibm.com/xmlns/prod/sn/calendar/event/attend" type="application/atom+xml"/>
Ignored
Use the web address in the href attribute to return list attendees of this event.
<link href="" rel="http://www.ibm.com/xmlns/prod/sn/calendar/event/follow" type="application/atom+xml"/>
Ignored
Use the web address in the href attribute to return list followers of this event.
<link href="" rel="http://www.ibm.com/xmlns/prod/sn/calendar/event/instances" type="application/atom+xml"/>
Ignored
Use the web address in the href attribute to return list event instances of this event.
<link href="" rel="http://www.ibm.com/xmlns/prod/sn/container" type="application/atom+xml"/>
Optional
Specifies the URL from which the owning community can be accessed.
<app:edited>
Ignored
Contains the date this entry was last modified, as defined in the Atom publishing protocol specification.
<app:control>
Optional
Indicates whether comments are allowed on this entry. As defined in the Atom publishing protocol specification; see table below for contents.
<content type="html">
Required
The content of event, as defined in the Atom specification.
<published>
Ignored
The date this event was created, as defined in the Atom specification.
<updated>
Ignored
The date this entry was updated, as defined in the Atom specification.
<author>
<name>
<email>
<snx:userid>
<snx:userState>
</author>
Ignored
The author of this event, as defined in the Atom specification. 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>
Ignored
An additional author that may contribute to the event with author permissions who is allowed to update the event, but is not an owner of the event. See Table 2 for possible values of this element. This element may repeat for additional contributors.
<category term="" scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
Optional
Defines the type of event instance. Currently there is only one option for term:
  • event-instance
<snx:location scheme="http://www.ibm.com/xmlns/prod/sn"/>
Optional
The location related to this event.
<snx:allday scheme="http://www.ibm.com/xmlns/prod/sn"/>
Required
Two options
  • 0 Not an allday event
  • 1 Allday event
<snx:recurrence frequency="daily" interval="null" custom="no" scheme="http://www.ibm.com/xmlns/prod/sn"/>
Optional
The repeat settings of this event.
frequency:
  • daily
  • weekly
interval:
Week interval. Value is number between 1 and 5.
See Table 2 for its elements.
<source />
Ignored
The source retrieving this event.
See Table 3 for its elements.
<collection herf="" xlmns="http://www.w3.org/2007/app"/>
Ignored
The event instance's collection. For comment collection the URL in href attribute can be used to post comments to this instance.
See Table 4 for its elements.
<snx:followed />
Ignored
For current login user, there are 3 options:
  • none

  • Not follow this instance
  • instance

  • Following this instance
  • series

  • Following entire series
<snx:attended />
Ignored
For current login user, there are 3 options:
  • none

  • Not attend this instance
  • instance

  • Attending this instance
  • series

  • Attending entire series
<snx:parentEvent />
Ignored
The id of the event that contains this instance
<link href="" rel="http://www.ibm.com/xmlns/prod/sn/calendar/event/parentevent" type="application/atom+xml"/>
Ignored
The href attribute defines parent event's content retrieving URL
<snx:communityUuid />
Ignored
Specify id of the community contains this instance

 

Table 2. Contents of the<snx:recurrence> element

 

 

Element
How treated on input
Description
<snx:untilscheme="http://www.ibm.com/xmlns/prod/sn"/>
Optional
Specify the end day of the repeating event.
<snx:allday scheme="http://www.ibm.com/xmlns/prod/sn"/>
Required
Two options
  • 0 Not an allday event
  • 1 Allday event
<snx:startDate scheme="http://www.ibm.com/xmlns/prod/sn"/>
Optional
Specify the start time of the event.
<snx:endDate scheme="http://www.ibm.com/xmlns/prod/sn"/>
Optional
Specify the end time of the event.
<snx:byDay scheme="http://www.ibm.com/xmlns/prod/sn"/>
Optional
The days in the week. Split by ','
FR,SA,SU,MO,TU,WE,TH

Table 3. Contents of the<source> element

 

Element
How treated on input
Description
<id>
Ignored
Unique identifier of the source. Usually it is community event widget.
<title type="text">
Ignored
Title of the source
<link rel="self" type="application/atom+xml" href="xxxxxx"/>
Ignored
Use the web address in the href attribute to return representation of this source.
<link rel="edit" type="application/atom+xml" href="edit_url"/>
Ignored
If you are an owner of the event, use this web address to update source.

Table 4. Contents of the<collection> element

 

Element
How treated on input
Description
<atom:title type="text">
Ignored
Specify the title of this collection
<category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="comment"/>
Ignored
Define the category.For comment collection, term equals "comment"
<accept />
Ignored
Content type of the post request