Represents calendar events.
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.
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.
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}
Entity class : org.sakaiproject.calendar.entityproviders.CalendarEventSummary
Type :: bean
|
Name |
Type |
Status |
| 1) | assignmentId | string | Read/Write |
| 2) | creator | string | Read/Write |
| 3) | description | string | Read/Write |
| 4) | duration | long | Read/Write |
| 5) | eventIcon | string | Read/Write |
| 6) | eventId | string | Read/Write |
| 7) | firstTime | org.sakaiproject.time.api.Time | Read/Write |
| 8) | recurrenceRule | org.sakaiproject.calendar.api.RecurrenceRule | Read/Write |
| 9) | reference | string | Read/Write |
| 10) | siteId | string | Read/Write |
| 11) | siteName | string | Read/Write |
| 12) | title | string | Read/Write |
| 13) | type | string | Read/Write |
Data and Request Handling
Output formats : json, xml, html
Input formats : No formats allowed
No Access Provider registered for request processing
Capabilities
| Name | Type | Description |
|---|
| 1 | EntityProvider | org.sakaiproject.entitybroker.entityprovider.EntityProvider | |
| 2 | ActionsExecutable | org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable | |
| 3 | AutoRegisterEntityProvider | org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider | |
| 4 | Describeable | org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable | |
| 5 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
| 6 | Sampleable | org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$