| $type |
AUTO_LINK |
required parameter |
N/A |
N/A |
The event type |
| $recurrence |
SHORT_TEXT |
required parameter |
N/A |
N/A |
The recurrence code (set to 'none' for no recurrences) |
| $recurrences |
?integer |
required parameter |
N/A |
N/A |
The number of recurrences (null: none/infinite) |
| $seg_recurrences |
BINARY |
required parameter |
N/A |
N/A |
Whether to segregate the comment-topics/rating/trackbacks per-recurrence |
| $title |
SHORT_TEXT |
required parameter |
N/A |
N/A |
The title of the event |
| $content |
LONG_TEXT |
required parameter |
N/A |
N/A |
The full text describing the event |
| $priority |
integer |
required parameter |
N/A |
N/A |
The priority |
| $start_year |
integer |
required parameter |
N/A |
N/A |
The year the event starts at |
| $start_month |
integer |
required parameter |
N/A |
N/A |
The month the event starts at |
| $start_day |
integer |
required parameter |
N/A |
N/A |
The day the event starts at |
| $start_monthly_spec_type |
ID_TEXT |
required parameter |
N/A |
N/A |
In-month specification type for start date |
| $start_hour |
?integer |
required parameter |
N/A |
N/A |
The hour the event starts at (null: all day) |
| $start_minute |
?integer |
required parameter |
N/A |
N/A |
The minute the event starts at (null: all day) |
| $end_year |
?integer |
Null |
N/A |
N/A |
The year the event ends at (null: not a multi day event) |
| $end_month |
?integer |
Null |
N/A |
N/A |
The month the event ends at (null: not a multi day event) |
| $end_day |
?integer |
Null |
N/A |
N/A |
The day the event ends at (null: not a multi day event) |
| $end_monthly_spec_type |
ID_TEXT |
day_of_month |
N/A |
N/A |
In-month specification type for end date |
| $end_hour |
?integer |
Null |
N/A |
N/A |
The hour the event ends at (null: not a multi day event) |
| $end_minute |
?integer |
Null |
N/A |
N/A |
The minute the event ends at (null: not a multi day event) |
| $timezone |
?ID_TEXT |
Null |
N/A |
N/A |
The timezone for the event (null: current user's timezone) |
| $do_timezone_conv |
BINARY |
1 |
N/A |
N/A |
Whether the time should be presented in the viewer's own timezone |
| $member_calendar |
?MEMBER |
Null |
N/A |
N/A |
The member's calendar it will be on (null: not on a specific member's calendar) |
| $validated |
BINARY |
1 |
N/A |
N/A |
Whether the event has been validated |
| $allow_rating |
BINARY |
1 |
N/A |
N/A |
Whether the event may be rated |
| $allow_comments |
SHORT_INTEGER |
1 |
N/A |
N/A |
Whether comments are allowed (0=no, 1=yes, 2=review style) |
| $allow_trackbacks |
BINARY |
1 |
N/A |
N/A |
Whether the event may be trackbacked |
| $notes |
LONG_TEXT |
Blank (empty string) |
N/A |
N/A |
Hidden notes pertaining to the event |
| $submitter |
?MEMBER |
Null |
N/A |
N/A |
The event submitter (null: current member) |
| $views |
integer |
0 |
N/A |
N/A |
The number of views so far |
| $add_time |
?TIME |
Null |
N/A |
N/A |
The add time (null: now) |
| $edit_time |
?TIME |
Null |
N/A |
N/A |
The edit time (null: never) |
| $id |
?AUTO_LINK |
Null |
N/A |
N/A |
Force an ID (null: don't force an ID) |
| $meta_keywords |
?SHORT_TEXT |
Blank (empty string) |
N/A |
N/A |
Meta keywords for this resource (null: do not edit) (blank: implicit) |
| $meta_description |
?LONG_TEXT |
Blank (empty string) |
N/A |
N/A |
Meta description for this resource (null: do not edit) (blank: implicit) |
| $regions |
array |
[] |
N/A |
N/A |
The regions (empty: not region-limited) |
