Authorization token required | true |
Admin Authorization token required | false |
Deprecation information | Note: This API is deprecated Use <SearchRequest> with the calExpandInstStart and calExpandInstEnd parameters |
<GetApptSummariesRequest s="{range-start-millis-gmt} (long)" e="{range-end-millis-gmt} (long)" [l="{folder-id}"] /> ## GetApptSummariesRequest
elements and attributes you can define within a
<GetApptSummariesRequest>
element:
XPath | Required / Optional | Description |
@s | Required (only 1) | Type: long Range start in milliseconds since the epoch GMT |
@e | Required (only 1) | Type: long Range end in milliseconds since the epoch GMT |
@l | Optional (0 or 1) | Type: String Folder ID. Optional folder to constrain requests to; otherwise, searches all folders but trash and spam |
<GetApptSummariesResponse> ## GetApptSummariesResponse
(<appt x_uid="..." uid="{icalendar-uid}" [f="{flags}"] [t="{tags}"] [tn="{tag-names}"] [l="{folder-id}"]
[s="{size} (Long)"] [md="{change-date} (Long)"] [ms="{modified-sequence} (Integer)"]
[rev="{revision} (Integer)"] [id="{id}"] [dur="{duration} (Long)"] [ptst="{participation-status}"]
[ridZ="{utc-recurrence-id-YYYYMMDD[ThhmmssZ]}"] [tzo="{tz-offset} (Long)"]
[fba="{actual-freebusy-status}"] [recur="{is-recurring} (0|1)"] [hasEx="{has-exceptions} (0|1)"]
[priority="{priority}"] [fb="{intended-freebusy}"] [transp="{transparency-O|T}"] [name="{name}"]
[loc="{location}"] [otherAtt="{has-other-attendees} (0|1)"] [alarm="{has-alarm} (0|1)"]
[isOrg="{default-am-i-organizer-flag} (0|1)"] [invId="{default-invite-mail-item-id}"]
[compNum="{default-invite-component-number} (Integer)"] [status="{status-TENT|CONF|CANC}"]
[class="{class}"] [allDay="{all-day} (0|1)"] [draft="{is-draft} (0|1)"] [neverSent="{never-sent} (0|1)"]
[tzoDue="{due-tz-offset} (Integer)"]> ## LegacyAppointmentData
<or [a="{email-address}"] [url="{url}"] [d="{friendly-name}"] [sentBy="{sent-by}"] [dir="{dir}"]
[lang="{language}"]> ## CalOrganizer
(<xparam name="{xparam-name}" value="{xparam-value}" /> ## XParam)*
</or>
(<category>{categories} (String)</category>)*
<geo [lat="{longitude}"] [lon="{longitude}"] /> ## GeoInfo
<fr>{fragment} (String)</fr>
(<inst [s="{start-time} (Long)"] [ex="{is-exception} (0|1)"] [d="{duration} (Long)"]
[ptst="{participation-status}"] [ridZ="{utc-recurrence-id-YYYYMMDD[ThhmmssZ]}"]
[tzo="{tz-offset} (Long)"] [fba="{actual-freebusy-status}"] [recur="{is-recurring} (0|1)"]
[hasEx="{has-exceptions} (0|1)"] [priority="{priority}"] [fb="{intended-freebusy}"]
[transp="{transparency-O|T}"] [name="{name}"] [loc="{location}"]
[otherAtt="{has-other-attendees} (0|1)"] [alarm="{has-alarm} (0|1)"]
[isOrg="{default-am-i-organizer-flag} (0|1)"] [invId="{default-invite-mail-item-id}"]
[compNum="{default-invite-component-number} (Integer)"] [status="{status-TENT|CONF|CANC}"]
[class="{class}"] [allDay="{all-day} (0|1)"] [draft="{is-draft} (0|1)"]
[neverSent="{never-sent} (0|1)"] [tzoDue="{due-tz-offset} (Integer)"]> ## LegacyInstanceDataInfo
<or ... > ... </or> ## See /appt/or [ ## CalOrganizer]
(<category>{categories} (String)</category>)*
<geo [lat="{longitude}"] [lon="{longitude}"] /> ## See /appt/geo [ ## GeoInfo]
<fr>{fragment} (String)</fr>
</inst>)*
<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}" /> ## See /appt/or/xparam [ ## XParam])*
</at>)*
(<xprop name="{xprop-name}" value="{xprop-value}"> ## XProp
(<xparam name="{xparam-name}" value="{xparam-value}" /> ## See /appt/or/xparam [ ## XParam])*
</xprop>)*
</alarm>
</alarmData>
</appt>)*
</GetApptSummariesResponse>
elements and attributes you can define within a
<GetApptSummariesResponse>
element:
XPath | Required / Optional | Description | ||||||
/appt | Optional (0 or more) | Appointment summaries | ||||||
/appt@x_uid | Required (only 1) | Type: String | ||||||
/appt@uid | Required (only 1) | Type: String iCalendar UID |
||||||
/appt@f | Optional (0 or 1) | Type: String Flags |
||||||
/appt@t | Optional (0 or 1) | Type: String Tags - Comma separated list of integers. DEPRECATED - use "tn" instead |
||||||
/appt@tn | Optional (0 or 1) | Type: String Comma-separated list of tag names |
||||||
/appt@l | Optional (0 or 1) | Type: String Folder ID |
||||||
/appt@s | Optional (0 or 1) | Type: Long Size |
||||||
/appt@md | Optional (0 or 1) | Type: Long Modified date in seconds |
||||||
/appt@ms | Optional (0 or 1) | Type: Integer Modified sequence |
||||||
/appt@rev | Optional (0 or 1) | Type: Integer Revision |
||||||
/appt@id | Optional (0 or 1) | Type: String ID |
||||||
/appt@dur | Optional (0 or 1) | Type: Long Duration |
||||||
/appt@ptst | Optional (0 or 1) | Type: String Your 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@ridZ | Optional (0 or 1) | Type: String RECURRENCE-ID in "Z" (UTC) timezone, if this is an exception. Format : YYYYMMDD[ThhmmssZ] |
||||||
/appt@tzo | Optional (0 or 1) | Type: Long Offset from GMT in milliseconds for start time in the time zone of the instance; this is useful because the instance time zone may not be the same as the time zone of the requesting client; when rendering an all-day appointment, the client must shift the appointment by the difference between the instance time zone and its local time zone to determine the correct date to render the all-day block |
||||||
/appt@fba | Optional (0 or 1) | Type: String Actual free-busy status: Free, Busy, busy-Tentative, busy-Unavailable (a.k.a. OutOfOffice) While free-busy status is simply a property of an event that is set during creation/update, "actual" free-busy status is the true free-busy state that depends on appt/invite free-busy, event scheduling status (confirmed vs. tentative vs. cancel), and more importantly, the attendee's participation status. For example, actual free-busy is busy-Tentative for an event with Busy free-busy value until the attendee has acted on the invite. |
||||||
/appt@recur | Optional (0 or 1) | Type: 0|1 If set, this is a recurring appointment |
||||||
/appt@hasEx | Optional (0 or 1) | Type: 0|1 If set, this is a recurring appointment with exceptions |
||||||
/appt@priority | Optional (0 or 1) | Type: String Priority |
||||||
/appt@fb | Optional (0 or 1) | Type: String Intended Free/Busy |
||||||
/appt@transp | Optional (0 or 1) | Type: String Transparency - O|T |
||||||
/appt@name | Optional (0 or 1) | Type: String Name |
||||||
/appt@loc | Optional (0 or 1) | Type: String Location |
||||||
/appt@otherAtt | Optional (0 or 1) | Type: 0|1 If set, this appointment has other attendees |
||||||
/appt@alarm | Optional (0 or 1) | Type: 0|1 Set if has alarm |
||||||
/appt@isOrg | Optional (0 or 1) | Type: 0|1 Default invite "am I organizer" flag |
||||||
/appt@invId | Optional (0 or 1) | Type: String Default invite mail item ID |
||||||
/appt@compNum | Optional (0 or 1) | Type: Integer Default invite component number |
||||||
/appt@status | Optional (0 or 1) | Type: String Status - TENT|CONF|CANC |
||||||
/appt@class | Optional (0 or 1) | Type: String Class |
||||||
/appt@allDay | Optional (0 or 1) | Type: 0|1 If set, this is an "all day" appointment |
||||||
/appt@draft | Optional (0 or 1) | Type: 0|1 Set if invite has changes that haven't been sent to attendees; for organizer only |
||||||
/appt@neverSent | Optional (0 or 1) | Type: 0|1 Set if attendees have never been notified for this invite; for organizer only, used in SetAppointmentRequest only |
||||||
/appt@tzoDue | Optional (0 or 1) | Type: Integer Similar to the "tzo" attribute but for "dueDate". "tzoDue" can be different from "tzo" if start date and due date lie on different sides of a daylight savings transition |
||||||
/appt/or | Optional (0 or 1) | Organizer | ||||||
/appt/or@a | Optional (0 or 1) | Type: String Email address (without "MAILTO:") |
||||||
/appt/or@url | Optional (0 or 1) | Type: String URL - has same value as {email-address}. Maintained for backwards compatibility with ZCS 4.5 |
||||||
/appt/or@d | Optional (0 or 1) | Type: String Friendly name - "CN" in iCalendar |
||||||
/appt/or@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/appt/or@dir | Optional (0 or 1) | Type: String iCalendar DIR - Reference to a directory entry associated with the calendar user. |
||||||
/appt/or@lang | Optional (0 or 1) | Type: String iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US") |
||||||
/appt/or/xparam | Optional (0 or more) | Non-standard parameters (XPARAMs) | ||||||
/appt/or/xparam@name | Required (only 1) | Type: String XPARAM Name |
||||||
/appt/or/xparam@value | Required (only 1) | Type: String XPARAM value |
||||||
/appt/category | Optional (0 or more) | Type: {categories} (String) Categories |
||||||
/appt/geo | Optional (0 or 1) | Information for iCalendar GEO property | ||||||
/appt/geo@lat | Optional (0 or 1) | Type: String Longitude (float value) |
||||||
/appt/geo@lon | Optional (0 or 1) | Type: String Longitude (float value) |
||||||
/appt/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/appt/inst | Optional (0 or more) | Instances | ||||||
/appt/inst@s | Optional (0 or 1) | Type: Long Start time |
||||||
/appt/inst@ex | Optional (0 or 1) | Type: 0|1 Set if is an exception |
||||||
/appt/inst@d | Optional (0 or 1) | Type: Long Duration |
||||||
/appt/inst@ptst | Optional (0 or 1) | Type: String Your 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/inst@ridZ | Optional (0 or 1) | Type: String RECURRENCE-ID in "Z" (UTC) timezone, if this is an exception. Format : YYYYMMDD[ThhmmssZ] |
||||||
/appt/inst@tzo | Optional (0 or 1) | Type: Long Offset from GMT in milliseconds for start time in the time zone of the instance; this is useful because the instance time zone may not be the same as the time zone of the requesting client; when rendering an all-day appointment, the client must shift the appointment by the difference between the instance time zone and its local time zone to determine the correct date to render the all-day block |
||||||
/appt/inst@fba | Optional (0 or 1) | Type: String Actual free-busy status: Free, Busy, busy-Tentative, busy-Unavailable (a.k.a. OutOfOffice) While free-busy status is simply a property of an event that is set during creation/update, "actual" free-busy status is the true free-busy state that depends on appt/invite free-busy, event scheduling status (confirmed vs. tentative vs. cancel), and more importantly, the attendee's participation status. For example, actual free-busy is busy-Tentative for an event with Busy free-busy value until the attendee has acted on the invite. |
||||||
/appt/inst@recur | Optional (0 or 1) | Type: 0|1 If set, this is a recurring appointment |
||||||
/appt/inst@hasEx | Optional (0 or 1) | Type: 0|1 If set, this is a recurring appointment with exceptions |
||||||
/appt/inst@priority | Optional (0 or 1) | Type: String Priority |
||||||
/appt/inst@fb | Optional (0 or 1) | Type: String Intended Free/Busy |
||||||
/appt/inst@transp | Optional (0 or 1) | Type: String Transparency - O|T |
||||||
/appt/inst@name | Optional (0 or 1) | Type: String Name |
||||||
/appt/inst@loc | Optional (0 or 1) | Type: String Location |
||||||
/appt/inst@otherAtt | Optional (0 or 1) | Type: 0|1 If set, this appointment has other attendees |
||||||
/appt/inst@alarm | Optional (0 or 1) | Type: 0|1 Set if has alarm |
||||||
/appt/inst@isOrg | Optional (0 or 1) | Type: 0|1 Default invite "am I organizer" flag |
||||||
/appt/inst@invId | Optional (0 or 1) | Type: String Default invite mail item ID |
||||||
/appt/inst@compNum | Optional (0 or 1) | Type: Integer Default invite component number |
||||||
/appt/inst@status | Optional (0 or 1) | Type: String Status - TENT|CONF|CANC |
||||||
/appt/inst@class | Optional (0 or 1) | Type: String Class |
||||||
/appt/inst@allDay | Optional (0 or 1) | Type: 0|1 If set, this is an "all day" appointment |
||||||
/appt/inst@draft | Optional (0 or 1) | Type: 0|1 Set if invite has changes that haven't been sent to attendees; for organizer only |
||||||
/appt/inst@neverSent | Optional (0 or 1) | Type: 0|1 Set if attendees have never been notified for this invite; for organizer only, used in SetAppointmentRequest only |
||||||
/appt/inst@tzoDue | Optional (0 or 1) | Type: Integer Similar to the "tzo" attribute but for "dueDate". "tzoDue" can be different from "tzo" if start date and due date lie on different sides of a daylight savings transition |
||||||
/appt/inst/or | Optional (0 or 1) | Organizer
See /appt/or for more details. |
||||||
/appt/inst/category | Optional (0 or more) | Type: {categories} (String) Categories |
||||||
/appt/inst/geo | Optional (0 or 1) | Information for iCalendar GEO property
See /appt/geo for more details. |
||||||
/appt/inst/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/appt/alarmData | Optional (0 or 1) | 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)
See /appt/or/xparam for more details. |
||||||
/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/or/xparam for more details. |