calendar (xml)

Represents calendar events.
RESTful URLs: http://microformats.org/wiki/rest/urls
HTTP response codes as returned by the system:
200 - OK (request is ok and content returned)
201 - CREATED (request created new content, URL and id of content in the header)
204 - NO CONTENT (request is ok but no content to return)
400 - ERROR (general error in the request, probably invalid parameters or data)
401 - UNAUTHORIZED (user authentication required for this request)
403 - FORBIDDEN (authorization required, insufficient privileges, user is already authenticated)
404 - NOT FOUND (resource not found, URL is invalid in some way, id or action are invalid)
405 - METHOD NOT ALLOWED (the method is not supported for this entity type)
406 - NOT ACCEPTABLE (the data format requested is unavailable for this entity type)
500 - INTERNAL SERVER ERROR (general server failure, probably a failure in the provider)
501 - NOT IMPLEMENTED (indicates that a prefix is invalid)

Custom Actions

site : list (GET) : [/calendar/site] (json) (xml) (html)
Retrieve the calendar events for a site. The request url pattern: /direct/calendar/site/{siteId}.{format} Optional query params: firstDate, ISO-8601 yyyy-MM-dd format. Used for filtering. lastDate, ISO-8601 yyyy-MM-dd format. Used for filtering.
event : list (GET) : [/calendar/event] (json) (xml) (html)
Retrieve a calendar event details specified by the site id and event id. The request url pattern: /direct/calendar/event/{siteId}/{eventId}.{format}
my : list (GET) : [/calendar/my] (json) (xml) (html)
Retrieve all my calendar events for all of my sites. The request url pattern: /direct/calendar/my.{format} Optional query params: firstDate, ISO-8601 yyyy-MM-dd format. Used for filtering. lastDate, ISO-8601 yyyy-MM-dd format. Used for filtering.

Entity class : org.sakaiproject.calendar.entityproviders.CalendarEventSummary

Type :: bean
Name Type Status
1) assignmentIdstringRead/Write
2) creatorstringRead/Write
3) descriptionstringRead/Write
4) durationlongRead/Write
5) eventIconstringRead/Write
6) eventIdstringRead/Write
7) firstTimeorg.sakaiproject.time.api.TimeRead/Write
8) recurrenceRuleorg.sakaiproject.calendar.api.RecurrenceRuleRead/Write
9) referencestringRead/Write
10) siteIdstringRead/Write
11) siteNamestringRead/Write
12) titlestringRead/Write
13) typestringRead/Write

Data and Request Handling

Output formats : json, xml, html
Input formats : No formats allowed
No Access Provider registered for request processing

Capabilities

NameTypeDescription
1EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
2ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
3AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
4Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
5Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
6Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

REST:: 1.0.1 SVN: $Revision$ : $Date$