Authorization token required | true |
Admin Authorization token required | false |
<SnoozeCalendarItemAlarmRequest> ## SnoozeCalendarItemAlarmRequest
(<appt id="{cal-item-id}" until="{new-alarm-time-millis} (long)" /> ## SnoozeAppointmentAlarm)*
</SnoozeCalendarItemAlarmRequest>
elements and attributes you can define within a
<SnoozeCalendarItemAlarmRequest>
element:
XPath | Required / Optional | Description |
/appt | Optional (0 or more) | Details of alarms |
/appt@id | Required (only 1) | Type: String Calendar item ID |
/appt@until | Required (only 1) | Type: long When to show the alarm again in milliseconds since the epoch |
<SnoozeCalendarItemAlarmResponse> ## SnoozeCalendarItemAlarmResponse
(<appt calItemId="{cal-item-id}"> ## UpdatedAppointmentAlarmInfo
<alarmData [nextAlarm="{next-alarm} (Long)"] [alarmInstStart="{instance-start-time} (Long)"]
[invId="{invite-mail-item-id} (Integer)"] [compNum="{component-num} (Integer)"]
[name="{meeting-subject}"] [loc="{meeting-location}"]> ## AlarmDataInfo
<alarm action="{alarm-action}"> ## AlarmInfo
<trigger> ## AlarmTriggerInfo
<abs d="{YYYYMMDDThhmmssZ}" /> ## DateAttr
<rel [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
</trigger>
<repeat ... /> ## See /appt/alarmData/alarm/trigger/rel [ ## DurationInfo]
<desc>{description} (String)</desc>
<attach [uri="{alarm-attach-uri}"] [ct="{alarm-attach-content-type}"]>{binaryB64Data}</attach> ## CalendarAttach
<summary>{summary} (String)</summary>
(<at [a="{email-address}"] [url="{url}"] [d="{friendly-name}"] [sentBy="{sent-by}"] [dir="{dir}"]
[lang="{language}"] [cutype="{calendar-user-type}"] [role="{role}"]
[ptst="{participation-status}"] [rsvp="{rsvp} (0|1)"] [member="{member}"]
[delTo="{delegated-to}"] [delFrom="{delegated-from}"]> ## CalendarAttendee
(<xparam name="{xparam-name}" value="{xparam-value}" /> ## XParam)*
</at>)*
(<xprop name="{xprop-name}" value="{xprop-value}"> ## XProp
(<xparam name="{xparam-name}" value="{xparam-value}" /> ## See /appt/alarmData/alarm/at/xparam [ ## XParam])*
</xprop>)*
</alarm>
</alarmData>
</appt>)*
</SnoozeCalendarItemAlarmResponse>
elements and attributes you can define within a
<SnoozeCalendarItemAlarmResponse>
element:
XPath | Required / Optional | Description | ||||||
/appt | Optional (0 or more) | Updated alarm information so the client knows when to trigger the next alarm | ||||||
/appt@calItemId | Required (only 1) | Type: String Calendar item ID |
||||||
/appt/alarmData | Optional (0 or 1) | Updated alarm information | ||||||
/appt/alarmData@nextAlarm | Optional (0 or 1) | Type: Long Time in millis to show the alarm |
||||||
/appt/alarmData@alarmInstStart | Optional (0 or 1) | Type: Long Start time of the meeting instance the alarm is reminding about |
||||||
/appt/alarmData@invId | Optional (0 or 1) | Type: Integer Mail Item ID of the invite message with detailed information |
||||||
/appt/alarmData@compNum | Optional (0 or 1) | Type: Integer Component number |
||||||
/appt/alarmData@name | Optional (0 or 1) | Type: String Meeting subject |
||||||
/appt/alarmData@loc | Optional (0 or 1) | Type: String Meeting location |
||||||
/appt/alarmData/alarm | Optional (0 or 1) | Details of the alarm | ||||||
/appt/alarmData/alarm@action | Required (only 1) | Type: String Alarm action Possible values: DISPLAY|AUDIO|EMAIL|PROCEDURE|X_YAHOO_CALENDAR_ACTION_IM|X_YAHOO_CALENDAR_ACTION_MOBILE |
||||||
/appt/alarmData/alarm/trigger | Optional (0 or 1) | Alarm trigger information | ||||||
/appt/alarmData/alarm/trigger/abs | Optional (0 or 1) | Absolute trigger information | ||||||
/appt/alarmData/alarm/trigger/abs@d | Required (only 1) | Type: String Date in format : YYYYMMDDThhmmssZ |
||||||
/appt/alarmData/alarm/trigger/rel | Optional (0 or 1) | Relative trigger information | ||||||
/appt/alarmData/alarm/trigger/rel@neg | Optional (0 or 1) | Type: 0|1 Set if the duration is negative. |
||||||
/appt/alarmData/alarm/trigger/rel@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) |
||||||
/appt/alarmData/alarm/trigger/rel@d | Optional (0 or 1) | Type: Integer Days component of the duration |
||||||
/appt/alarmData/alarm/trigger/rel@h | Optional (0 or 1) | Type: Integer Hours component of the duration |
||||||
/appt/alarmData/alarm/trigger/rel@m | Optional (0 or 1) | Type: Integer Minutes component of the duration |
||||||
/appt/alarmData/alarm/trigger/rel@s | Optional (0 or 1) | Type: Integer Seconds component of the duration |
||||||
/appt/alarmData/alarm/trigger/rel@related | Optional (0 or 1) | Type: String Specifies whether the alarm is related to the start of end. Valid values are : START|END |
||||||
/appt/alarmData/alarm/trigger/rel@count | Optional (0 or 1) | Type: Integer Alarm repeat count |
||||||
/appt/alarmData/alarm/repeat | Optional (0 or 1) | Alarm repeat information
See /appt/alarmData/alarm/trigger/rel for more details. |
||||||
/appt/alarmData/alarm/desc | Optional (0 or 1) | Type: {description} (String) Alarm description
|
||||||
/appt/alarmData/alarm/attach | Optional (0 or 1) | Type: {binaryB64Data} Information on attachment Description for element text content:Base64 encoded binary alarrm attach data |
||||||
/appt/alarmData/alarm/attach@uri | Optional (0 or 1) | Type: String URI |
||||||
/appt/alarmData/alarm/attach@ct | Optional (0 or 1) | Type: String Content Type for {base64-encoded-binary-alarm-attach-data} |
||||||
/appt/alarmData/alarm/summary | Optional (0 or 1) | Type: {summary} (String) Alarm summary |
||||||
/appt/alarmData/alarm/at | Optional (0 or more) | Attendee information | ||||||
/appt/alarmData/alarm/at@a | Optional (0 or 1) | Type: String Email address (without "MAILTO:") |
||||||
/appt/alarmData/alarm/at@url | Optional (0 or 1) | Type: String URL - has same value as {email-address}. Maintained for backwards compatibility with ZCS 4.5 |
||||||
/appt/alarmData/alarm/at@d | Optional (0 or 1) | Type: String Friendly name - "CN" in iCalendar |
||||||
/appt/alarmData/alarm/at@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/appt/alarmData/alarm/at@dir | Optional (0 or 1) | Type: String iCalendar DIR - Reference to a directory entry associated with the calendar user. the property. |
||||||
/appt/alarmData/alarm/at@lang | Optional (0 or 1) | Type: String iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US") |
||||||
/appt/alarmData/alarm/at@cutype | Optional (0 or 1) | Type: String iCalendar CUTYPE (Calendar user type) |
||||||
/appt/alarmData/alarm/at@role | Optional (0 or 1) | Type: String iCalendar ROLE |
||||||
/appt/alarmData/alarm/at@ptst | Optional (0 or 1) | Type: String iCalendar PTST (Participation status) Valid values: NE|AC|TE|DE|DG|CO|IN|WE|DF Meanings: "NE"eds-action, "TE"ntative, "AC"cept, "DE"clined, "DG" (delegated), "CO"mpleted (todo), "IN"-process (todo), "WA"iting (custom value only for todo), "DF" (deferred; custom value only for todo) |
||||||
/appt/alarmData/alarm/at@rsvp | Optional (0 or 1) | Type: 0|1 iCalendar RSVP |
||||||
/appt/alarmData/alarm/at@member | Optional (0 or 1) | Type: String iCalendar MEMBER - The group or list membership of the calendar user |
||||||
/appt/alarmData/alarm/at@delTo | Optional (0 or 1) | Type: String iCalendar DELEGATED-TO |
||||||
/appt/alarmData/alarm/at@delFrom | Optional (0 or 1) | Type: String iCalendar DELEGATED-FROM |
||||||
/appt/alarmData/alarm/at/xparam | Optional (0 or more) | Non-standard parameters (XPARAMs) | ||||||
/appt/alarmData/alarm/at/xparam@name | Required (only 1) | Type: String XPARAM Name |
||||||
/appt/alarmData/alarm/at/xparam@value | Required (only 1) | Type: String XPARAM value |
||||||
/appt/alarmData/alarm/xprop | Optional (0 or more) | Non-standard properties (see RFC2445 section 4.8.8.1)
e.g. iCalendar: X-FOO-HELLO;X-FOO-WORLD=world:helloSOAP: <xprop name="X-FOO-HELLO" value="hello"> <xparam name="X-FOO-WORLD" value="world"/> </xprop> |
||||||
/appt/alarmData/alarm/xprop@name | Required (only 1) | Type: String XPROP name |
||||||
/appt/alarmData/alarm/xprop@value | Required (only 1) | Type: String XPROP value |
||||||
/appt/alarmData/alarm/xprop/xparam | Optional (0 or more) | XPARAMs
See /appt/alarmData/alarm/at/xparam for more details. |