Authorization token required | true |
Admin Authorization token required | false |
<ExpandRecurRequest s="{start-time-millis} (long)" e="{end-time-millis} (long)"> ## ExpandRecurRequest
(<tz id="{timezone-id}" stdoff="{timezone-std-offset} (Integer)" dayoff="{timezone-daylight-offset} (Integer)"
[stdname="..."] [dayname="..."]> ## CalTZInfo
<standard [week="{tzonset-week} (Integer)"] [wkday="{tzonset-day-of-week} (Integer)"]
mon="{tzonset-month} (Integer)" [mday="{tzonset-day-of-month} (Integer)"]
hour="{tzonset-hour} (Integer)" min="{tzonset-minute} (Integer)" sec="{tzonset-second} (Integer)" /> ## TzOnsetInfo
<daylight ... /> ## See /tz/standard [ ## TzOnsetInfo]
</tz>)*
List of any of: {
<comp [s="{dtstart-millis} (Long)"] [e="{dtend-millis} (Long)"]> ## ExpandedRecurrenceInvite
<exceptId [range="{range-THISANDFUTURE|THISANDPRIOR}"] [d="{DATETIME-YYYYMMDD['T'HHMMSS[Z]]}"]
[tz="{timezone-identifier}"] /> ## InstanceRecurIdInfo
<dur [neg="{duration-negative} (0|1)"] [w="{duration-weeks} (Integer)"] [d="{duration-days} (Integer)"]
[h="{duration-hours} (Integer)"] [m="{duration-minutes} (Integer)"]
[s="{duration-seconds} (Integer)"] [related="{alarm-related}"]
[count="{alarm-repeat-count} (Integer)"] /> ## DurationInfo
<recur> ## RecurrenceInfo
List of any of: {
<add> ## AddRecurrenceInfo
List of any of: {
<add> ... </add> ## See /comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
<exclude> ## ExcludeRecurrenceInfo
List of any of: {
<add> ... </add> ## See /comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
<exclude> ... </exclude> ## See /comp/recur/add/exclude [ ## ExcludeRecurrenceInfo] # [inside itself]
<except rangeType="{range-type} (int)" recurId="{YYMMDD[THHMMSS[Z]]}"
[tz="{timezone-name}"] [ridZ="{YYMMDDTHHMMSSZ}"]> ## ExceptionRuleInfo
<add> ... </add> ## See /comp/recur [ ## RecurrenceInfo] # [inside itself]
<exclude> ... </exclude> ## See /comp/recur [ ## RecurrenceInfo] # [inside itself]
</except>
<cancel rangeType="{range-type} (int)" recurId="{YYMMDD[THHMMSS[Z]]}"
[tz="{timezone-name}"] [ridZ="{YYMMDDTHHMMSSZ}"] /> ## CancelRuleInfo
<dates [tz="{TZID}"]> ## SingleDates
(<dtval> ## DtVal
<s [d="{YYYYMMDD['T'HHMMSS[Z]]}"] [tz="{timezone-identifier}"]
[u="{utc-time} (Long)"] /> ## DtTimeInfo
<e ... /> ## See /comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<dur ... /> ## See /comp/dur [ ## DurationInfo]
</dtval>)*
</dates>
<rule freq="{freq}"> ## SimpleRepeatingRule
<until d="{YYYYMMDD[ThhmmssZ]}" /> ## DateTimeStringAttr
<count num="{num} (int)" /> ## NumAttr
<interval ival="{rule-interval} (int)" /> ## IntervalRule
<bysecond seclist="{second-list}" /> ## BySecondRule
<byminute minlist="{minute-list}" /> ## ByMinuteRule
<byhour hrlist="{hour-list}" /> ## ByHourRule
<byday> ## ByDayRule
(<wkday day="{weekday}" [ordwk="{ord-wk-[[+]|-]num} (Integer)"] /> ## WkDay)*
</byday>
<bymonthday modaylist="{modaylist}" /> ## ByMonthDayRule
<byyearday yrdaylist="{byyearday-yrdaylist}" /> ## ByYearDayRule
<byweekno wklist="{byweekno-wklist}" /> ## ByWeekNoRule
<bymonth molist="{month-list}" /> ## ByMonthRule
<bysetpos poslist="{bysetpos-list}" /> ## BySetPosRule
<wkst day="{weekday}" /> ## WkstRule
(<rule-x-name [name="{xname-name}"] [value="{xname-value}"] /> ## XNameRule)*
</rule>
}
</exclude>
<except ... > ... </except> ## See /comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
<cancel ... /> ## See /comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
<dates [tz="{TZID}"]> ... </dates> ## See /comp/recur/add/exclude/dates [ ## SingleDates]
<rule freq="{freq}"> ... </rule> ## See /comp/recur/add/exclude/rule [ ## SimpleRepeatingRule]
}
</add>
<exclude> ... </exclude> ## See /comp/recur/add/exclude [ ## ExcludeRecurrenceInfo]
<except ... > ... </except> ## See /comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
<cancel ... /> ## See /comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
<dates [tz="{TZID}"]> ... </dates> ## See /comp/recur/add/exclude/dates [ ## SingleDates]
<rule freq="{freq}"> ... </rule> ## See /comp/recur/add/exclude/rule [ ## SimpleRepeatingRule]
}
</recur>
</comp>
<except [s="{dtstart-millis} (Long)"] [e="{dtend-millis} (Long)"]> ## ExpandedRecurrenceException
<exceptId ... /> ## See /comp/exceptId [ ## InstanceRecurIdInfo]
<dur ... /> ## See /comp/dur [ ## DurationInfo]
<recur> ... </recur> ## See /comp/recur [ ## RecurrenceInfo]
</except>
<cancel [s="{dtstart-millis} (Long)"] [e="{dtend-millis} (Long)"]> ## ExpandedRecurrenceCancel
<exceptId ... /> ## See /comp/exceptId [ ## InstanceRecurIdInfo]
<dur ... /> ## See /comp/dur [ ## DurationInfo]
<recur> ... </recur> ## See /comp/recur [ ## RecurrenceInfo]
</cancel>
}
</ExpandRecurRequest>
elements and attributes you can define within a
<ExpandRecurRequest>
element:
XPath | Required / Optional | Description |
@s | Required (only 1) | Type: long Start time in milliseconds |
@e | Required (only 1) | Type: long End time in milliseconds |
/tz | Optional (0 or more) | Timezone definitions |
/tz@id | Required (only 1) | Type: String Timezone ID. If this is the only detail present then this should be an existing server-known timezone's ID Otherwise, it must be present, although it will be ignored by the server |
/tz@stdoff | Required (only 1) | Type: Integer Standard Time's offset in minutes from UTC; local = UTC + offset |
/tz@dayoff | Required (only 1) | Type: Integer Daylight Saving Time's offset in minutes from UTC; present only if DST is used |
/tz@stdname | Optional (0 or 1) | Type: String Standard Time component's timezone name |
/tz@dayname | Optional (0 or 1) | Type: String Daylight Saving Time component's timezone name |
/tz/standard | Optional (0 or 1) | Time/rule for transitioning from daylight time to standard time. Either specify week/wkday combo, or mday. |
/tz/standard@week | Optional (0 or 1) | Type: Integer Week number; 1=first, 2=second, 3=third, 4=fourth, -1=last |
/tz/standard@wkday | Optional (0 or 1) | Type: Integer Day of week; 1=Sunday, 2=Monday, etc. |
/tz/standard@mon | Required (only 1) | Type: Integer Month; 1=January, 2=February, etc. |
/tz/standard@mday | Optional (0 or 1) | Type: Integer Day of month (1..31) |
/tz/standard@hour | Required (only 1) | Type: Integer Transition hour (0..23) |
/tz/standard@min | Required (only 1) | Type: Integer Transition minute (0..59) |
/tz/standard@sec | Required (only 1) | Type: Integer Transition second; 0..59, usually 0 |
/tz/daylight | Optional (0 or 1) | Time/rule for transitioning from standard time to daylight time
See /tz/standard for more details. |
/comp | Optional (0 or 1) | |
/comp@s | Optional (0 or 1) | Type: Long DTSTART time in milliseconds since the Epoch |
/comp@e | Optional (0 or 1) | Type: Long DTEND time in milliseconds since the Epoch |
/comp/exceptId | Optional (0 or 1) | RECURRENCE_ID |
/comp/exceptId@range | Optional (0 or 1) | Type: String Range - THISANDFUTURE|THISANDPRIOR |
/comp/exceptId@d | Optional (0 or 1) | Type: String Date and/or time. Format is : YYYYMMDD['T'HHMMSS[Z]] where: YYYY - 4 digit year MM - 2 digit month DD - 2 digit day Optionally: 'T' the literal char "T" then HH - 2 digit hour (00-23) MM - 2 digit minute (00-59) SS - 2 digit second (00-59) ...and finally an optional "Z" meaning that the time is UTC, otherwise the tz="TIMEZONE" param MUST be specified with the DATETIME e.g: 20050612 June 12, 2005 20050315T18302305Z March 15, 2005 6:30:23.05 PM UTC |
/comp/exceptId@tz | Optional (0 or 1) | Type: String Java timezone identifier |
/comp/dur | Optional (0 or 1) | DURATION |
/comp/dur@neg | Optional (0 or 1) | Type: 0|1 Set if the duration is negative. |
/comp/dur@w | Optional (0 or 1) | Type: Integer Weeks component of the duration Special note: if WEEKS are specified, NO OTHER OFFSET MAY BE SPECIFIED (weeks must be alone, per RFC2445) |
/comp/dur@d | Optional (0 or 1) | Type: Integer Days component of the duration |
/comp/dur@h | Optional (0 or 1) | Type: Integer Hours component of the duration |
/comp/dur@m | Optional (0 or 1) | Type: Integer Minutes component of the duration |
/comp/dur@s | Optional (0 or 1) | Type: Integer Seconds component of the duration |
/comp/dur@related | Optional (0 or 1) | Type: String Specifies whether the alarm is related to the start of end. Valid values are : START|END |
/comp/dur@count | Optional (0 or 1) | Type: Integer Alarm repeat count |
/comp/recur | Optional (0 or 1) | RRULE/RDATE/EXDATE information |
/comp/recur/add | Optional (0 or 1) | |
/comp/recur/add/add | Optional (0 or 1) | See /comp/recur/add for more details. |
/comp/recur/add/exclude | Optional (0 or 1) | |
/comp/recur/add/exclude/add | Optional (0 or 1) | See /comp/recur/add for more details. |
/comp/recur/add/exclude/exclude | Optional (0 or 1) | See /comp/recur/add/exclude for more details. |
/comp/recur/add/exclude/except | Optional (0 or 1) | |
/comp/recur/add/exclude/except@rangeType | Required (only 1) | Type: int Recurrence range type |
/comp/recur/add/exclude/except@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
/comp/recur/add/exclude/except@tz | Optional (0 or 1) | Type: String Timezone name |
/comp/recur/add/exclude/except@ridZ | Optional (0 or 1) | Type: String Recurrence-id in UTC time zone; used in non-all-day appointments only Format: YYMMDDTHHMMSSZ |
/comp/recur/add/exclude/except/add | Optional (0 or 1) | Dates or rules which ADD instances. ADDs are evaluated before EXCLUDEs
See /comp/recur for more details. |
/comp/recur/add/exclude/except/exclude | Optional (0 or 1) | Dates or rules which EXCLUDE instances
See /comp/recur for more details. |
/comp/recur/add/exclude/cancel | Optional (0 or 1) | |
/comp/recur/add/exclude/cancel@rangeType | Required (only 1) | Type: int Recurrence range type |
/comp/recur/add/exclude/cancel@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
/comp/recur/add/exclude/cancel@tz | Optional (0 or 1) | Type: String Timezone name |
/comp/recur/add/exclude/cancel@ridZ | Optional (0 or 1) | Type: String Recurrence-id in UTC time zone; used in non-all-day appointments only Format: YYMMDDTHHMMSSZ |
/comp/recur/add/exclude/dates | Optional (0 or 1) | |
/comp/recur/add/exclude/dates@tz | Optional (0 or 1) | Type: String TZID |
/comp/recur/add/exclude/dates/dtval | Optional (0 or more) | Information on start date/time and end date/time or duration |
/comp/recur/add/exclude/dates/dtval/s | Optional (0 or 1) | Start DATE-TIME |
/comp/recur/add/exclude/dates/dtval/s@d | Optional (0 or 1) | Type: String Date and/or time. Format is : YYYYMMDD['T'HHMMSS[Z]] where: YYYY - 4 digit year MM - 2 digit month DD - 2 digit day Optionally: 'T' the literal char "T" then HH - 2 digit hour (00-23) MM - 2 digit minute (00-59) SS - 2 digit second (00-59) ...and finally an optional "Z" meaning that the time is UTC, otherwise the tz="TIMEZONE" param MUST be specified with the DATETIME e.g: 20050612 June 12, 2005 20050315T18302305Z March 15, 2005 6:30:23.05 PM UTC |
/comp/recur/add/exclude/dates/dtval/s@tz | Optional (0 or 1) | Type: String Java timezone identifier |
/comp/recur/add/exclude/dates/dtval/s@u | Optional (0 or 1) | Type: Long UTC time as milliseconds since the epoch. Set if non-all-day |
/comp/recur/add/exclude/dates/dtval/e | Optional (0 or 1) | Start DATE-TIME
See /comp/recur/add/exclude/dates/dtval/s for more details. |
/comp/recur/add/exclude/dates/dtval/dur | Optional (0 or 1) | Duration information
See /comp/dur for more details. |
/comp/recur/add/exclude/rule | Optional (0 or 1) | |
/comp/recur/add/exclude/rule@freq | Required (only 1) | Type: String Frequency - SEC,MIN,HOU,DAI,WEE,MON,YEA |
/comp/recur/add/exclude/rule/until | Optional (0 or 1) | UNTIL date specification |
/comp/recur/add/exclude/rule/until@d | Required (only 1) | Type: String Date in format : YYYYMMDD[ThhmmssZ] |
/comp/recur/add/exclude/rule/count | Optional (0 or 1) | Count of instances to generate |
/comp/recur/add/exclude/rule/count@num | Required (only 1) | Type: int Number |
/comp/recur/add/exclude/rule/interval | Optional (0 or 1) | Interval specification |
/comp/recur/add/exclude/rule/interval@ival | Required (only 1) | Type: int Rule interval count - a positive integer |
/comp/recur/add/exclude/rule/bysecond | Optional (0 or 1) | BYSECOND rule |
/comp/recur/add/exclude/rule/bysecond@seclist | Required (only 1) | Type: String Comma separated list of seconds where second is a number between 0 and 59 |
/comp/recur/add/exclude/rule/byminute | Optional (0 or 1) | BYMINUTE rule |
/comp/recur/add/exclude/rule/byminute@minlist | Required (only 1) | Type: String Comma separated list of minutes where minute is a number between 0 and 59 |
/comp/recur/add/exclude/rule/byhour | Optional (0 or 1) | BYHOUR rule |
/comp/recur/add/exclude/rule/byhour@hrlist | Required (only 1) | Type: String Comma separated list of hours where hour is a number between 0 and 23 |
/comp/recur/add/exclude/rule/byday | Optional (0 or 1) | BYDAY rule |
/comp/recur/add/exclude/rule/byday/wkday | Optional (0 or more) | By day weekday rule specification |
/comp/recur/add/exclude/rule/byday/wkday@day | Required (only 1) | Type: String Weekday - SU|MO|TU|WE|TH|FR|SA |
/comp/recur/add/exclude/rule/byday/wkday@ordwk | Optional (0 or 1) | Type: Integer Week number. [[+]|-]num num: 1 to 53 |
/comp/recur/add/exclude/rule/bymonthday | Optional (0 or 1) | BYMONTHDAY rule |
/comp/recur/add/exclude/rule/bymonthday@modaylist | Required (only 1) | Type: String Comma separated list of day numbers from either the start (positive) or the end (negative) of the month - format : [[+]|-]num[,...] where num between 1 to 31 e.g. modaylist="1,+2,-7" means first day of the month, plus the 2nd day of the month, plus the 7th from last day of the month. |
/comp/recur/add/exclude/rule/byyearday | Optional (0 or 1) | BYYEARDAY rule |
/comp/recur/add/exclude/rule/byyearday@yrdaylist | Required (only 1) | Type: String BYYEARDAY yearday list. Format : [[+]|-]num[,...]" where num is between 1 and 366 e.g. <byyearday yrdaylist="1,+2,-1"/> means January 1st, January 2nd, and December 31st. |
/comp/recur/add/exclude/rule/byweekno | Optional (0 or 1) | BYWEEKNO rule |
/comp/recur/add/exclude/rule/byweekno@wklist | Required (only 1) | Type: String BYWEEKNO Week list. Format : [[+]|-]num[,...] where num is between 1 and 53 e.g. <byweekno wklist="1,+2,-1"/> means first week, 2nd week, and last week of the year. |
/comp/recur/add/exclude/rule/bymonth | Optional (0 or 1) | BYMONTH rule |
/comp/recur/add/exclude/rule/bymonth@molist | Required (only 1) | Type: String Comma separated list of months where month is a number between 1 and 12 |
/comp/recur/add/exclude/rule/bysetpos | Optional (0 or 1) | BYSETPOS rule |
/comp/recur/add/exclude/rule/bysetpos@poslist | Required (only 1) | Type: String Format [[+]|-]num[,...] where num is from 1 to 366 <bysetpos> MUST only be used in conjunction with another <byXXX> element. |
/comp/recur/add/exclude/rule/wkst | Optional (0 or 1) | Week start day - SU,MO,TU,WE,TH,FR,SA |
/comp/recur/add/exclude/rule/wkst@day | Required (only 1) | Type: String Weekday - SU|MO|TU|WE|TH|FR|SA |
/comp/recur/add/exclude/rule/rule-x-name | Optional (0 or more) | X Name rules |
/comp/recur/add/exclude/rule/rule-x-name@name | Optional (0 or 1) | Type: String XNAME Name |
/comp/recur/add/exclude/rule/rule-x-name@value | Optional (0 or 1) | Type: String XNAME Value |
/comp/recur/add/except | Optional (0 or 1) | See /comp/recur/add/exclude/except for more details. |
/comp/recur/add/cancel | Optional (0 or 1) | See /comp/recur/add/exclude/cancel for more details. |
/comp/recur/add/dates | Optional (0 or 1) | See /comp/recur/add/exclude/dates for more details. |
/comp/recur/add/rule | Optional (0 or 1) | See /comp/recur/add/exclude/rule for more details. |
/comp/recur/exclude | Optional (0 or 1) | See /comp/recur/add/exclude for more details. |
/comp/recur/except | Optional (0 or 1) | See /comp/recur/add/exclude/except for more details. |
/comp/recur/cancel | Optional (0 or 1) | See /comp/recur/add/exclude/cancel for more details. |
/comp/recur/dates | Optional (0 or 1) | See /comp/recur/add/exclude/dates for more details. |
/comp/recur/rule | Optional (0 or 1) | See /comp/recur/add/exclude/rule for more details. |
/except | Optional (0 or 1) | |
/except@s | Optional (0 or 1) | Type: Long DTSTART time in milliseconds since the Epoch |
/except@e | Optional (0 or 1) | Type: Long DTEND time in milliseconds since the Epoch |
/except/exceptId | Optional (0 or 1) | RECURRENCE_ID
See /comp/exceptId for more details. |
/except/dur | Optional (0 or 1) | DURATION
See /comp/dur for more details. |
/except/recur | Optional (0 or 1) | RRULE/RDATE/EXDATE information
See /comp/recur for more details. |
/cancel | Optional (0 or 1) | |
/cancel@s | Optional (0 or 1) | Type: Long DTSTART time in milliseconds since the Epoch |
/cancel@e | Optional (0 or 1) | Type: Long DTEND time in milliseconds since the Epoch |
/cancel/exceptId | Optional (0 or 1) | RECURRENCE_ID
See /comp/exceptId for more details. |
/cancel/dur | Optional (0 or 1) | DURATION
See /comp/dur for more details. |
/cancel/recur | Optional (0 or 1) | RRULE/RDATE/EXDATE information
See /comp/recur for more details. |
<ExpandRecurResponse> ## ExpandRecurResponse
(<inst [s="{start-time-millis} (Long)"] [dur="{duration-millies} (Long)"] [allDay="{is-all-day} (0|1)"]
[tzo="{tz-offset-millis} (Integer)"] [ridZ="{utc-recurrence-id}"] /> ## ExpandedRecurrenceInstance)*
</ExpandRecurResponse>
elements and attributes you can define within a
<ExpandRecurResponse>
element:
XPath | Required / Optional | Description |
/inst | Optional (0 or more) | Expanded recurrence instances |
/inst@s | Optional (0 or 1) | Type: Long Start time in milliseconds |
/inst@dur | Optional (0 or 1) | Type: Long Duration in milliseconds |
/inst@allDay | Optional (0 or 1) | Type: 0|1 Set if the instance is for an all day appointment |
/inst@tzo | Optional (0 or 1) | Type: Integer GMT offset of start time in milliseconds; returned only when allDay is set |
/inst@ridZ | Optional (0 or 1) | Type: String Recurrence ID string in UTC timezone |