Please see the full REST API documentation for API implementation details.

Resource: Recurrence

A recurrence specifies a schedule for a recurring event. Lucid supports recurrence for the meeting series resource.

A recurrence resource is created when a meeting series is created, and can be modified or deleted only by modifying or deleting the meeting series with which it is associated.

Properties

Recurrence properties in Lucid Meetings closely mirror those of Recurrence Rules in RFC 5545, Internet Calendaring and Scheduling Core Object Specification, with some additional convenience properties.

Note that although Lucid Meetings aims to support any recurrence pattern as defined in RFC 5545, patterns with a greater frequency than DAILY (for example, HOURLY) probably don't make sense for meetings and may not be reflected sensibly in Lucid. The API may reject such recurrence definitions in the future.

Field Type Notes
recurrence_id integer
meeting_series_id integer ID of the meeting series for which this recurrence provides the schedule
rrule plain text An RRULE (RFC 5545: RRULE)
dtstart string DTSTART rule specifying the start time of the first meeting in the series, in date-with-local-time format suitable for use in iCalendar applications (RFC 5545: DTSTART)
dtuntil string, null UNTIL specifying the end date of the series, in date-with-local-time format suitable for use in iCalendar applications (RFC 5545: UNTIL)
until string, null alias for dtuntil
rcount integer, null Count of events in the series. This value will be present only if the recurrence was specified with the rcount paramater. A series with an end date will not necessarily have an rcount, even though it contains a finite number of events. (RFC 5545: RCOUNT)
timezone_name plain text Timezone, specified as a name from the tz database. (RFC5545: TZID)
start_ts timestamp Start time of the first meeting in the series.
until_ts timestamp, null End time for the last meeting in the series. This field may be populated even if UNTIL is not, for example, if the recurrence has an rcount value.
event_duration tuple event (meeting) duration: {seconds, friendly display}
added_dates list [dates] Additional event dates beyond the pattern specified by RRULE. (see RFC 5545: RDATE. The added_dates splits the RDATE property's comma-separated string into a list.)
excluded_dates list [dates] Dates in the recurrence pattern for which meetings have been deleted (but not for canceled meetings). (see RFC 5545: EXDATE. The excluded_dates splits the EXDATE property's comma-separated string into a list.)
rrule_parts object The elements of the rrule, parsed:
              "freq": a string, e.g., "MONTHLY"
              "interval": a non-zero integer
              "bymonthdays": a list of dates in the range 1-31
              "daysofweek": a list of day-of-week abbreviations
              "weekstart": a day-of-week abbreviation, e.g.,  "MO"