This API is deprecated. Use the Calendar Rest services V1 instead!
The CalendarWebservice class contains services to interact with the Calendar application and its data in a RESTFull manner. These services are accessible applications inside and outside eXo Platform. For example, Gadgets and Mobile applications can use them.
| Resource | Description |
|---|---|
| GET /cs/calendar/checkPermission/{username}/{calendarId}/{type}/ | Checks permission of the currently logged-in user on any calendar by the given calendar Id. The input parameters will be in the URL of the calendar. |
| GET /cs/calendar/event/{username}/{eventFeedName}/ | Provides details of an event with the given username and the event Id. The returned data is in the XML format containing the details of the event, including the link to the event's ICS file. |
| GET /cs/calendar/feed/{username}/{feedname}/{filename}/ | Returns the XML RSS feed data of one user's calendar. |
| GET /cs/calendar/subscribe/{username}/{calendarId}/{type} | Provides an end-point to subscribe a calendar of the platform. |
| GET /cs/calendar/{username}/{calendarId}/{type} | Generates the ICalendar data from a given calendar Id. The data content will be all events of the calendar. This service requires authentication and permission of the Users group only. |
| GET /cs/calendar/events/personal/{type}/{calids}/{from}/{to}/{limit} | Gets a list of personal events by their type, calendar Ids, the starting/ending time, and the maximum number of returned events. This service requires authentication and permission of the Users group only. |
| GET /cs/calendar/getissues/{currentdatetime}/{type}/{limit} | Lists upcoming events or tasks by the current date. This service requires authentication and permission of the Users group only. |
| GET /cs/calendar/updatestatus/{taskid}/{statusid} | Allows users to update the status of a task. This service requires authentication and permission of the Users group only. |
| GET /cs/calendar/getcalendars | Retrieves all data of a private (personal) calendar of a logged-in user. It requires authentication and permission of the Users group only. |
| GET /cs/calendar/getevent/{eventid} | Produces the content of a given private event, based on its Id. It requires authentication and permission of the Users group only. |
| GET /cs/calendar/geteventbyid/{eventid} | Returns the details of an event identified by its Id. It requires authentication and permission of the Users group only. |
| GET /cs/calendar/getoccurrence/{eventid}/{recurid} | Produces the content of an occurrence of a repetitive event, based on its event Id and occurrence Id. It requires authentication and permission of the Users group only. |
| GET /cs/calendar/invitation/{calendarId}/{calType}/{eventId}/{inviter}/{invitee}/{eXoId}/{answer} | Provides the end-point to answer or reply an invitation to join any given event by its Id. |