Spongecell API Documentation: Reference - Widgets
Widgets
Lets you view, modify, and delete information your widgets. You can also create new widgets.
The index action will return a summary view of each widget owned by the currently authenticated user, while the show action will return a detailed view of a specific widget, including calendar information, and all the widget properties.
Show available fields for creating or updating a widget: /api/widgets/new.
Examples
Please log in (above) to see more examples.
Show the sample widget: /api/widgets/139.
Actions
The following actions are supported for this resource:
| index | GET | /api/widgets | Returns all the widgets for the currently authenticated user. |
| event_id | INTEGER | The id of the event | |
| show | GET | /api/widgets/1 | Return an expanded set of fields for the specified resource. |
| new | GET | /api/widgets/new | Construct a new resource (do NOT save it), returning the editable fields with default values. |
| edit | GET | /api/widgets/1/edit | Return the editable fields for the specified resource. |
| create | POST | /api/widgets | Create a new resource from the data in the POST request. |
| event_id | INTEGER | The id of the event | |
| email_address | STRING | Email address | |
| response | STRING | The response: YES, MAYBE, NO | |
| name | STRING | Name | |
| comment | STRING | The comment text | |
| number | INTEGER | The number responding (default is 1; must be > 0) | |
| plus_n | INTEGER | The number responding, in addition (default is 0; must be >= 0) | |
| opt_in | BOOLEAN | Whether to opt the email or sms address in to the list | |
| update | PUT | /api/widgets/1 | Update the specified resource with the data in the POST request. |
| destroy | DELETE | /api/widgets/1 | Delete the specified resource. |