Spongecell API Documentation: Reference - Calendars
Calendars
Lets you view public calendars as well as calendars that the currently authenticated user is entitled to view.
The index action will return a summary view of each calendar owned by the currently authenticated user, while the show action will return a detailed view of a specific calendar, including the events for that calendar.
Examples
Please log in (above) to see more examples.
Show the sample calendar: /api/calendars/62739.
Show up to 20 events after a specified time: /api/calendars/62739?start_time=200705111700&max_results=20.
Actions
The following actions are supported for this resource:
| index | GET | /api/calendars | Returns all the calendars for the currently authenticated user. |
| show | GET | /api/calendars/1 | Returns the user id of the logged in user. |
| start_time | DATETIME | Only include events on or after specified date and time | |
| max_results | INTEGER | The maximum number of results to return. If not specified, default is 50. | |
| new | GET | /api/calendars/new | Construct a new resource (do NOT save it), returning the editable fields with default values. |
| edit | GET | /api/calendars/1/edit | Return the editable fields for the specified resource. |
| create | POST | /api/calendars | Create the session, i.e. log user in. |
| name | STRING | Name | |
| description | STRING | Description | |
| update | PUT | /api/calendars/1 | Update the specified resource with the data in the POST request. |
| name | STRING | Name | |
| description | STRING | Description | |
| destroy | DELETE | /api/calendars/1 | Destroys the session, i.e. log user out. |