Retrieving event instances from a specified community
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 9, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Retrieving event instances from a specified community, belonging to a given period.
Tags: commapi

Request parameters

You can use one or more of the input parameters to limit the number of event instances returned in the feed. Separate multiple parameters with an ampersand (&).

Note: If only endDate parameter is provided, the feed will return a list of past events. The return data is sort in event instance start date descending order. Otherwise, the return data is sort in event instance start date ascending order.

If done properly, you will make an Atom feed document containing the community event instance atom entries.

Input
Method URI Description
GET /communities/calendar/atom/calendar/event Value of the href attribute of <collection title="Event Entries"> element in User's Service Document
Name Type Optional Description
page
int Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps
int Yes Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 100.
calendarUuid
string No The uuid of community that you want to query about. This is a mandatory parameter.
startDate
string Yes Includes in the resulting feed all those event instances that end after a specified date. Specify the date using a date-time value that conforms to RFC3339. In addition, an uppercase "T" character must be used to separate date and time, and an uppercase "Z" character must be present in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z.
The parameter is not mandatory. But it should at least specify one "startDate" or "endDate" parameter. Omit both parameters are not valid.
endDate
string Yes Includes in the resulting feed all those event instances that end before a specified date. Specify the date using a date-time value that conforms to RFC3339. In addition, an uppercase "T" character must be used to separate date and time, and an uppercase "Z" character must be present in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z.
The parameter is not mandatory. But it should at least specify one "startDate" or "endDate" parameter. Omit both parameters are not valid.
tags
string Yes Returns community event instances with the specified tags. Separate multiple tags with a plus sign (+).
Output
Content Type: application/atom+xml
Code Description
200
Indicates that the community event instances were successfully found and returned. If an error occurs, this header will contain one of the error codes below.
400
Bad Request.
401
Unauthorized.
403
Forbidden.
404
Not Found.