Service: zimbraMail
Namespace: "urn:zimbraMail"
GetAppointment SOAP Command

Get Appointment. Returns the metadata info for each Invite that makes up this appointment.
The content (original email) for each invite is stored within the Appointment itself in a big multipart/digest containing each invite in the appointment as a sub-mimepart it can be retreived from the content servlet:

     http://servername/service/content/get?id=<calItemId>
 
The content for a single Invite can be requested from the content servlet (or from <GetMsg>) Individual. The client can ALSO request just the content for each individual invite using a compound item-id request:
     http://servername/service/content/get?id="calItemId-invite_mail_item_id"
     <GetMsgRequest><m id="calItemId-invite_mail_item_id"
 
IMPORTANT NOTE: DO NOT use the raw invite-mail-item-id to fetch the content: it might work sometimes, however the invite is a standard mail-message it can be deleted by the user at any time!

Authorization token required true
Admin Authorization token required false

GetAppointmentRequest

    <GetAppointmentRequest [sync="{return-mod-date} (0|1)"] [includeContent="{include-mime-body-parts} (0|1)"]
                              [includeInvites="{include-invites} (0|1)"] [uid="{icalendar-uid}"] [id="{appointment-id}"] /> ## GetAppointmentRequest

The following table describes elements and attributes you can define within a <GetAppointmentRequest> element:

XPath Required / Optional Description
@sync Optional (0 or 1) Type:0|1
Set this to return the modified date (md) on the appointment.
@includeContent Optional (0 or 1) Type:0|1
If set, MIME parts for body content are returned; default unset
@includeInvites Optional (0 or 1) Type:0|1
If set, information for each invite is included; default set
@uid Optional (0 or 1) Type:String
iCalendar UID Either id or uid should be specified, but not both
@id Optional (0 or 1) Type:String
Appointment ID. Either id or uid should be specified, but not both

GetAppointmentResponse

    <GetAppointmentResponse> ## GetAppointmentResponse
        Choose one of: {
            <appt [f="{flags}"] [t="{tags}"] [tn="{tag-names}"] [uid="{icalendar-uid}"] [id="{appointment-id}"]
                      [rev="{revision-number} (Integer)"] [s="{size} (Long)"] [d="{date} (Long)"] [l="{folder-id}"]
                      [md="{change-date} (Long)"] [ms="{modified-sequence} (Integer)"] [nextAlarm="{next-alarm} (Long)"]
                      [orphan="{orphan} (0|1)"]> ## CalendarItemInfo
                (<inv type="{type-appt|task}" seq="{sequence-number} (Integer)"
                          id="{invite-original-mail-item-id} (Integer)" compNum="{component-number} (Integer)"
                          [recurId="{YYMMDD[THHMMSS[Z]]}"]> ## Invitation
                    (<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 /appt/inv/tz/standard [ ## TzOnsetInfo]
                      </tz>)*
                    <comp [method="{invite-comp-method}"] [compNum="{invite-comp-num} (Integer)"] [rsvp="{rsvp} (0|1)"]
                              [priority="{invite-comp-priority-0-9}"] [name="{invite-comp-name}"]
                              [loc="{invite-comp-location}"] [percentComplete="{task-percent-complete}"]
                              [completed="{task-completed-yyyyMMddThhmmssZ}"] [noBlob="{no-blob-data} (0|1)"]
                              [fba="{freebusy-actual}"] [fb="{freebusy-status}"] [transp="{transparency}"]
                              [isOrg="{is-organizer} (0|1)"] [x_uid="{x-uid}"] [uid="{uid-for-create}"]
                              [seq="{sequence-num} (Integer)"] [d="{invite-comp-date} (Long)"]
                              [calItemId="{mail-item-id-of-appointment}"] [apptId="{deprecated-appt-id}"]
                              [ciFolder="{cal-item-folder}"] [status="{invite-comp-status}"] [class="{invite-comp-class}"]
                              [url="{invite-comp-url}"] [ex="{is-exception} (0|1)"] [ridZ="{utc-recurrence-id}"]
                              [allDay="{is-all-day} (0|1)"] [draft="{is-draft} (0|1)"]
                              [neverSent="{attendees-never-notified} (0|1)"] [changes="{comma-sep-changed-data}"]> ## InviteComponent
                        (<category>{categories} (String)</category>)*
                        (<comment>{comments} (String)</comment>)*
                        (<contact>{contacts} (String)</contact>)*
                        <geo [lat="{longitude}"] [lon="{longitude}"] /> ## GeoInfo
                        (<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>)*
                        (<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/inv/comp/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 ... > ... </at> ## See /appt/inv/comp/at [ ## CalendarAttendee])*
                            (<xprop name="{xprop-name}" value="{xprop-value}"> ## XProp
                                (<xparam name="{xparam-name}" value="{xparam-value}" /> ## See /appt/inv/comp/at/xparam [ ## XParam])*
                              </xprop>)*
                          </alarm>)*
                        (<xprop name="{xprop-name}" value="{xprop-value}"> ... </xprop> ## See /appt/inv/comp/alarm/xprop [ ## XProp])*
                        <fr>{fragment} (String)</fr>
                        <desc>{description} (String)</desc>
                        <descHtml>{htmlDescription} (String)</descHtml>
                        <or [a="{email-address}"] [url="{url}"] [d="{friendly-name}"] [sentBy="{sent-by}"] [dir="{dir}"]
                                [lang="{language}"]> ## CalOrganizer
                            (<xparam name="{xparam-name}" value="{xparam-value}" /> ## See /appt/inv/comp/at/xparam [ ## XParam])*
                         </or>
                        <recur> ## RecurrenceInfo
                            List of any of: {
                                <add> ## AddRecurrenceInfo
                                    List of any of: {
                                        <add> ... </add> ## See /appt/inv/comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
                                        <exclude> ## ExcludeRecurrenceInfo
                                            List of any of: {
                                                <add> ... </add> ## See /appt/inv/comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
                                                <exclude> ... </exclude> ## See /appt/inv/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 /appt/inv/comp/recur [ ## RecurrenceInfo] # [inside itself]
                                                    <exclude> ... </exclude> ## See /appt/inv/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 /appt/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
                                                        <dur ... /> ## See /appt/inv/comp/alarm/trigger/rel [ ## 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 /appt/inv/comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
                                        <cancel ... /> ## See /appt/inv/comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
                                        <dates [tz="{TZID}"]> ... </dates> ## See /appt/inv/comp/recur/add/exclude/dates [ ## SingleDates]
                                        <rule freq="{freq}"> ... </rule> ## See /appt/inv/comp/recur/add/exclude/rule [ ## SimpleRepeatingRule]
                                    }
                                 </add>
                                <exclude> ... </exclude> ## See /appt/inv/comp/recur/add/exclude [ ## ExcludeRecurrenceInfo]
                                <except ... > ... </except> ## See /appt/inv/comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
                                <cancel ... /> ## See /appt/inv/comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
                                <dates [tz="{TZID}"]> ... </dates> ## See /appt/inv/comp/recur/add/exclude/dates [ ## SingleDates]
                                <rule freq="{freq}"> ... </rule> ## See /appt/inv/comp/recur/add/exclude/rule [ ## SimpleRepeatingRule]
                            }
                         </recur>
                        <exceptId d="{DATETIME-YYYYMMDD['T'HHMMSS[Z]]}" [tz="{timezone-identifier}"]
                                      [rangeType="{range-type} (Integer)"] /> ## ExceptionRecurIdInfo
                        <s ... /> ## See /appt/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
                        <e ... /> ## See /appt/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
                        <dur ... /> ## See /appt/inv/comp/alarm/trigger/rel [ ## DurationInfo]
                     </comp>
                    List of any of: {
                        <mp part="{mime-part-name}" ct="{content-type}" [s="{size-in-bytes} (Integer)"]
                                [cd="{content-disp}"] [filename="{filename}"] [ci="{content-id}"] [cl="{content-location}"]
                                [body="{is-body} (0|1)"] [truncated="{truncated-content} (0|1)"]> ## PartInfo
                            <content>{content} (String)</content>
                            (<mp> ... </mp> ## See /appt/inv/mp [ ## PartInfo] # [inside itself])*
                         </mp>
                        <shr [truncated="{truncated-flag} (0|1)"]> ## ShareNotification
                            <content>{content} (String)</content>
                         </shr>
                        <dlSubs [truncated="{truncated-flag} (0|1)"]> ## DLSubscriptionNotification
                            <content>{content} (String)</content>
                         </dlSubs>
                    }
                  </inv>)*
                <replies>
                    (<reply seq="{sequence-num} (int)" d="{dtstamp} (long)" at="{attendee}" [sentBy="{sent-by}"]
                                [ptst="{participation-status}"] rangeType="{range-type} (int)"
                                recurId="{YYMMDD[THHMMSS[Z]]}" [tz="{timezone-name}"] [ridZ="{YYMMDDTHHMMSSZ}"] /> ## CalendarReply)*
                </replies>
                (<meta [section="{section}"]> ## MailCustomMetadata
                    (<a n="{key}">{value}</a> ## KeyValuePair)*
                  </meta>)*
             </appt>
            <task [f="{flags}"] [t="{tags}"] [tn="{tag-names}"] [uid="{icalendar-uid}"] [id="{appointment-id}"]
                      [rev="{revision-number} (Integer)"] [s="{size} (Long)"] [d="{date} (Long)"] [l="{folder-id}"]
                      [md="{change-date} (Long)"] [ms="{modified-sequence} (Integer)"] [nextAlarm="{next-alarm} (Long)"]
                      [orphan="{orphan} (0|1)"]> ## TaskItemInfo
                (<inv ... > ... </inv> ## See /appt/inv [ ## Invitation])*
                <replies>
                    (<reply ... /> ## See /appt/replies/reply [ ## CalendarReply])*
                </replies>
                (<meta [section="{section}"]> ... </meta> ## See /appt/meta [ ## MailCustomMetadata])*
             </task>
        }
    </GetAppointmentResponse>

The following table describes elements and attributes you can define within a <GetAppointmentResponse> element:

XPath Required / Optional Description
/appt Optional (0 or 1)
/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@uid Optional (0 or 1) Type:String
iCalendar UID
/appt@id Optional (0 or 1) Type:String
Appointment ID
/appt@rev Optional (0 or 1) Type:Integer
Revision number
/appt@s Optional (0 or 1) Type:Long
Size
/appt@d Optional (0 or 1) Type:Long
Date
/appt@l Optional (0 or 1) Type:String
Folder ID
/appt@md Optional (0 or 1) Type:Long
Modified date in seconds
/appt@ms Optional (0 or 1) Type:Integer
Modified sequence
/appt@nextAlarm Optional (0 or 1) Type:Long
Next alarm time
/appt@orphan Optional (0 or 1) Type:0|1
Has exceptions but no series
/appt/inv Optional (0 or more) Invites
/appt/inv@type Required (only 1) Type:String
Calendar item type - appt|task
/appt/inv@seq Required (only 1) Type:Integer
Sequence number
/appt/inv@id Required (only 1) Type:Integer
Original mail item ID for invite
/appt/inv@compNum Required (only 1) Type:Integer
Component number
/appt/inv@recurId Optional (0 or 1) Type:String
Recurrence ID in format : YYMMDD[THHMMSS[Z]]
/appt/inv/tz Optional (0 or more) Timezones
/appt/inv/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
/appt/inv/tz@stdoff Required (only 1) Type:Integer
Standard Time's offset in minutes from UTC; local = UTC + offset
/appt/inv/tz@dayoff Required (only 1) Type:Integer
Daylight Saving Time's offset in minutes from UTC; present only if DST is used
/appt/inv/tz@stdname Optional (0 or 1) Type:String
Standard Time component's timezone name
/appt/inv/tz@dayname Optional (0 or 1) Type:String
Daylight Saving Time component's timezone name
/appt/inv/tz/standard Optional (0 or 1) Time/rule for transitioning from daylight time to standard time. Either specify week/wkday combo, or mday.
/appt/inv/tz/standard@week Optional (0 or 1) Type:Integer
Week number; 1=first, 2=second, 3=third, 4=fourth, -1=last
/appt/inv/tz/standard@wkday Optional (0 or 1) Type:Integer
Day of week; 1=Sunday, 2=Monday, etc.
/appt/inv/tz/standard@mon Required (only 1) Type:Integer
Month; 1=January, 2=February, etc.
/appt/inv/tz/standard@mday Optional (0 or 1) Type:Integer
Day of month (1..31)
/appt/inv/tz/standard@hour Required (only 1) Type:Integer
Transition hour (0..23)
/appt/inv/tz/standard@min Required (only 1) Type:Integer
Transition minute (0..59)
/appt/inv/tz/standard@sec Required (only 1) Type:Integer
Transition second; 0..59, usually 0
/appt/inv/tz/daylight Optional (0 or 1) Time/rule for transitioning from standard time to daylight time
See /appt/inv/tz/standard for more details.
/appt/inv/comp Optional (0 or 1) Invite component
/appt/inv/comp@method Optional (0 or 1) Type:String
Method
/appt/inv/comp@compNum Optional (0 or 1) Type:Integer
Component number of the invite
/appt/inv/comp@rsvp Optional (0 or 1) Type:0|1
RSVP flag. Set if response requested, unset if no response requested
/appt/inv/comp@priority Optional (0 or 1) Type:String
Priority (0 - 9; default = 0)
/appt/inv/comp@name Optional (0 or 1) Type:String
NAME
/appt/inv/comp@loc Optional (0 or 1) Type:String
Location
/appt/inv/comp@percentComplete Optional (0 or 1) Type:String
Percent complete for VTODO (0 - 100; default = 0)
/appt/inv/comp@completed Optional (0 or 1) Type:String
VTODO COMPLETED DATE-TIME in format yyyyMMddThhmmssZ
/appt/inv/comp@noBlob Optional (0 or 1) Type:0|1
Set if invite has no blob data, i.e. all data is in db metadata
/appt/inv/comp@fba Optional (0 or 1) Type:String
The "actual" free-busy status of this invite (ie what the client should display). This is synthesized taking into account our Attendee's PartStat, the Opacity of the appointment, its Status, etc...
Valid values - F|B|T|U. i.e. Free, Busy (default), busy-Tentative, OutOfOffice (busy-unavailable)
/appt/inv/comp@fb Optional (0 or 1) Type:String
FreeBusy setting F|B|T|U
i.e. Free, Busy (default), busy-Tentative, OutOfOffice (busy-unavailable)
/appt/inv/comp@transp Optional (0 or 1) Type:String
Transparency - O|T. i.e. Opaque or Transparent
/appt/inv/comp@isOrg Optional (0 or 1) Type:0|1
Am I the organizer? [default 0 (false)]
/appt/inv/comp@x_uid Optional (0 or 1) Type:String
x_uid
/appt/inv/comp@uid Optional (0 or 1) Type:String
UID to use when creating appointment. Optional: client can request the UID to use
/appt/inv/comp@seq Optional (0 or 1) Type:Integer
Sequence number (default = 0)
/appt/inv/comp@d Optional (0 or 1) Type:Long
Date - used for zdsync
/appt/inv/comp@calItemId Optional (0 or 1) Type:String
Mail item ID of appointment
/appt/inv/comp@apptId Optional (0 or 1) Type:String
Appointment ID (deprecated)
/appt/inv/comp@ciFolder Optional (0 or 1) Type:String
Folder of appointment
/appt/inv/comp@status Optional (0 or 1) Type:String
Status - TENT|CONF|CANC|NEED|COMP|INPR|WAITING|DEFERRED
i.e. TENTative, CONFirmed, CANCelled, COMPleted, INPRogress, WAITING, DEFERRED
where waiting and Deferred are custom values not found in the iCalendar spec.
/appt/inv/comp@class Optional (0 or 1) Type:String
Class = PUB|PRI|CON. i.e. PUBlic (default), PRIvate, CONfidential
/appt/inv/comp@url Optional (0 or 1) Type:String
URL
/appt/inv/comp@ex Optional (0 or 1) Type:0|1
Set if this is invite is an exception
/appt/inv/comp@ridZ Optional (0 or 1) Type:String
Recurrence-id string in UTC timezone
/appt/inv/comp@allDay Optional (0 or 1) Type:0|1
Set if is an all day appointment
/appt/inv/comp@draft Optional (0 or 1) Type:0|1
Set if invite has changes that haven't been sent to attendees; for organizer only
/appt/inv/comp@neverSent Optional (0 or 1) Type:0|1
Set if attendees were never notified of this invite; for organizer only
/appt/inv/comp@changes Optional (0 or 1) Type:String
Comma-separated list of changed data in an updated invite.
Possible values are "subject", "location", "time" (start time, end time, or duration), and "recurrence".
/appt/inv/comp/category Optional (0 or more) Type:{categories} (String)
Categories - for iCalendar CATEGORY properties
/appt/inv/comp/comment Optional (0 or more) Type:{comments} (String)
Comments - for iCalendar COMMENT properties
/appt/inv/comp/contact Optional (0 or more) Type:{contacts} (String)
Contacts - for iCalendar CONTACT properties
/appt/inv/comp/geo Optional (0 or 1) for iCalendar GEO property
/appt/inv/comp/geo@lat Optional (0 or 1) Type:String
Longitude (float value)
/appt/inv/comp/geo@lon Optional (0 or 1) Type:String
Longitude (float value)
/appt/inv/comp/at Optional (0 or more) Attendees
/appt/inv/comp/at@a Optional (0 or 1) Type:String
Email address (without "MAILTO:")
/appt/inv/comp/at@url Optional (0 or 1) Type:String
URL - has same value as {email-address}.
Maintained for backwards compatibility with ZCS 4.5
/appt/inv/comp/at@d Optional (0 or 1) Type:String
Friendly name - "CN" in iCalendar
/appt/inv/comp/at@sentBy Optional (0 or 1) Type:String
iCalendar SENT-BY
/appt/inv/comp/at@dir Optional (0 or 1) Type:String
iCalendar DIR - Reference to a directory entry associated with the calendar user. the property.
/appt/inv/comp/at@lang Optional (0 or 1) Type:String
iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US")
/appt/inv/comp/at@cutype Optional (0 or 1) Type:String
iCalendar CUTYPE (Calendar user type)
/appt/inv/comp/at@role Optional (0 or 1) Type:String
iCalendar ROLE
/appt/inv/comp/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/inv/comp/at@rsvp Optional (0 or 1) Type:0|1
iCalendar RSVP
/appt/inv/comp/at@member Optional (0 or 1) Type:String
iCalendar MEMBER - The group or list membership of the calendar user
/appt/inv/comp/at@delTo Optional (0 or 1) Type:String
iCalendar DELEGATED-TO
/appt/inv/comp/at@delFrom Optional (0 or 1) Type:String
iCalendar DELEGATED-FROM
/appt/inv/comp/at/xparam Optional (0 or more) Non-standard parameters (XPARAMs)
/appt/inv/comp/at/xparam@name Required (only 1) Type:String
XPARAM Name
/appt/inv/comp/at/xparam@value Required (only 1) Type:String
XPARAM value
/appt/inv/comp/alarm Optional (0 or more) Alarm information
/appt/inv/comp/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/inv/comp/alarm/trigger Optional (0 or 1) Alarm trigger information
/appt/inv/comp/alarm/trigger/abs Optional (0 or 1) Absolute trigger information
/appt/inv/comp/alarm/trigger/abs@d Required (only 1) Type:String
Date in format : YYYYMMDDThhmmssZ
/appt/inv/comp/alarm/trigger/rel Optional (0 or 1) Relative trigger information
/appt/inv/comp/alarm/trigger/rel@neg Optional (0 or 1) Type:0|1
Set if the duration is negative.
/appt/inv/comp/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/inv/comp/alarm/trigger/rel@d Optional (0 or 1) Type:Integer
Days component of the duration
/appt/inv/comp/alarm/trigger/rel@h Optional (0 or 1) Type:Integer
Hours component of the duration
/appt/inv/comp/alarm/trigger/rel@m Optional (0 or 1) Type:Integer
Minutes component of the duration
/appt/inv/comp/alarm/trigger/rel@s Optional (0 or 1) Type:Integer
Seconds component of the duration
/appt/inv/comp/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/inv/comp/alarm/trigger/rel@count Optional (0 or 1) Type:Integer
Alarm repeat count
/appt/inv/comp/alarm/repeat Optional (0 or 1) Alarm repeat information
See /appt/inv/comp/alarm/trigger/rel for more details.
/appt/inv/comp/alarm/desc Optional (0 or 1) Type:{description} (String)
Alarm description
action=DISPLAY Reminder text to display
action=EMAIL|X_YAHOO_CALENDAR_ACTION_IM|X_YAHOO_CALENDAR_ACTION_MOBILE EMail body
action=PROCEDURE Description text
/appt/inv/comp/alarm/attach Optional (0 or 1) Type:{binaryB64Data}
Information on attachment
Description for element text content:Base64 encoded binary alarrm attach data
/appt/inv/comp/alarm/attach@uri Optional (0 or 1) Type:String
URI
/appt/inv/comp/alarm/attach@ct Optional (0 or 1) Type:String
Content Type for {base64-encoded-binary-alarm-attach-data}
/appt/inv/comp/alarm/summary Optional (0 or 1) Type:{summary} (String)
Alarm summary
/appt/inv/comp/alarm/at Optional (0 or more) Attendee information
See /appt/inv/comp/at for more details.
/appt/inv/comp/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:hello
 
SOAP:
     <xprop name="X-FOO-HELLO" value="hello">
         <xparam name="X-FOO-WORLD" value="world"/>
     </xprop>
 
/appt/inv/comp/alarm/xprop@name Required (only 1) Type:String
XPROP name
/appt/inv/comp/alarm/xprop@value Required (only 1) Type:String
XPROP value
/appt/inv/comp/alarm/xprop/xparam Optional (0 or more) XPARAMs
See /appt/inv/comp/at/xparam for more details.
/appt/inv/comp/xprop Optional (0 or more) iCalender XPROP properties
See /appt/inv/comp/alarm/xprop for more details.
/appt/inv/comp/fr Optional (0 or 1) Type:{fragment} (String)
First few bytes of the message (probably between 40 and 100 bytes)
/appt/inv/comp/desc Optional (0 or 1) Type:{description} (String)
Present if noBlob is set and invite has a plain text description
/appt/inv/comp/descHtml Optional (0 or 1) Type:{htmlDescription} (String)
Present if noBlob is set and invite has an HTML description
/appt/inv/comp/or Optional (0 or 1) Organizer
/appt/inv/comp/or@a Optional (0 or 1) Type:String
Email address (without "MAILTO:")
/appt/inv/comp/or@url Optional (0 or 1) Type:String
URL - has same value as {email-address}.
Maintained for backwards compatibility with ZCS 4.5
/appt/inv/comp/or@d Optional (0 or 1) Type:String
Friendly name - "CN" in iCalendar
/appt/inv/comp/or@sentBy Optional (0 or 1) Type:String
iCalendar SENT-BY
/appt/inv/comp/or@dir Optional (0 or 1) Type:String
iCalendar DIR - Reference to a directory entry associated with the calendar user.
/appt/inv/comp/or@lang Optional (0 or 1) Type:String
iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US")
/appt/inv/comp/or/xparam Optional (0 or more) Non-standard parameters (XPARAMs)
See /appt/inv/comp/at/xparam for more details.
/appt/inv/comp/recur Optional (0 or 1) Recurrence information
/appt/inv/comp/recur/add Optional (0 or 1)
/appt/inv/comp/recur/add/add Optional (0 or 1) See /appt/inv/comp/recur/add for more details.
/appt/inv/comp/recur/add/exclude Optional (0 or 1)
/appt/inv/comp/recur/add/exclude/add Optional (0 or 1) See /appt/inv/comp/recur/add for more details.
/appt/inv/comp/recur/add/exclude/exclude Optional (0 or 1) See /appt/inv/comp/recur/add/exclude for more details.
/appt/inv/comp/recur/add/exclude/except Optional (0 or 1)
/appt/inv/comp/recur/add/exclude/except@rangeType Required (only 1) Type:int
Recurrence range type
/appt/inv/comp/recur/add/exclude/except@recurId Required (only 1) Type:String
Recurrence ID in format : YYMMDD[THHMMSS[Z]]
/appt/inv/comp/recur/add/exclude/except@tz Optional (0 or 1) Type:String
Timezone name
/appt/inv/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
/appt/inv/comp/recur/add/exclude/except/add Optional (0 or 1) Dates or rules which ADD instances. ADDs are evaluated before EXCLUDEs
See /appt/inv/comp/recur for more details.
/appt/inv/comp/recur/add/exclude/except/exclude Optional (0 or 1) Dates or rules which EXCLUDE instances
See /appt/inv/comp/recur for more details.
/appt/inv/comp/recur/add/exclude/cancel Optional (0 or 1)
/appt/inv/comp/recur/add/exclude/cancel@rangeType Required (only 1) Type:int
Recurrence range type
/appt/inv/comp/recur/add/exclude/cancel@recurId Required (only 1) Type:String
Recurrence ID in format : YYMMDD[THHMMSS[Z]]
/appt/inv/comp/recur/add/exclude/cancel@tz Optional (0 or 1) Type:String
Timezone name
/appt/inv/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
/appt/inv/comp/recur/add/exclude/dates Optional (0 or 1)
/appt/inv/comp/recur/add/exclude/dates@tz Optional (0 or 1) Type:String
TZID
/appt/inv/comp/recur/add/exclude/dates/dtval Optional (0 or more) Information on start date/time and end date/time or duration
/appt/inv/comp/recur/add/exclude/dates/dtval/s Optional (0 or 1) Start DATE-TIME
/appt/inv/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
 
/appt/inv/comp/recur/add/exclude/dates/dtval/s@tz Optional (0 or 1) Type:String
Java timezone identifier
/appt/inv/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
/appt/inv/comp/recur/add/exclude/dates/dtval/e Optional (0 or 1) Start DATE-TIME
See /appt/inv/comp/recur/add/exclude/dates/dtval/s for more details.
/appt/inv/comp/recur/add/exclude/dates/dtval/dur Optional (0 or 1) Duration information
See /appt/inv/comp/alarm/trigger/rel for more details.
/appt/inv/comp/recur/add/exclude/rule Optional (0 or 1)
/appt/inv/comp/recur/add/exclude/rule@freq Required (only 1) Type:String
Frequency - SEC,MIN,HOU,DAI,WEE,MON,YEA
/appt/inv/comp/recur/add/exclude/rule/until Optional (0 or 1) UNTIL date specification
/appt/inv/comp/recur/add/exclude/rule/until@d Required (only 1) Type:String
Date in format : YYYYMMDD[ThhmmssZ]
/appt/inv/comp/recur/add/exclude/rule/count Optional (0 or 1) Count of instances to generate
/appt/inv/comp/recur/add/exclude/rule/count@num Required (only 1) Type:int
Number
/appt/inv/comp/recur/add/exclude/rule/interval Optional (0 or 1) Interval specification
/appt/inv/comp/recur/add/exclude/rule/interval@ival Required (only 1) Type:int
Rule interval count - a positive integer
/appt/inv/comp/recur/add/exclude/rule/bysecond Optional (0 or 1) BYSECOND rule
/appt/inv/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
/appt/inv/comp/recur/add/exclude/rule/byminute Optional (0 or 1) BYMINUTE rule
/appt/inv/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
/appt/inv/comp/recur/add/exclude/rule/byhour Optional (0 or 1) BYHOUR rule
/appt/inv/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
/appt/inv/comp/recur/add/exclude/rule/byday Optional (0 or 1) BYDAY rule
/appt/inv/comp/recur/add/exclude/rule/byday/wkday Optional (0 or more) By day weekday rule specification
/appt/inv/comp/recur/add/exclude/rule/byday/wkday@day Required (only 1) Type:String
Weekday - SU|MO|TU|WE|TH|FR|SA
/appt/inv/comp/recur/add/exclude/rule/byday/wkday@ordwk Optional (0 or 1) Type:Integer
Week number. [[+]|-]num num: 1 to 53
/appt/inv/comp/recur/add/exclude/rule/bymonthday Optional (0 or 1) BYMONTHDAY rule
/appt/inv/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.
/appt/inv/comp/recur/add/exclude/rule/byyearday Optional (0 or 1) BYYEARDAY rule
/appt/inv/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.
/appt/inv/comp/recur/add/exclude/rule/byweekno Optional (0 or 1) BYWEEKNO rule
/appt/inv/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.
/appt/inv/comp/recur/add/exclude/rule/bymonth Optional (0 or 1) BYMONTH rule
/appt/inv/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
/appt/inv/comp/recur/add/exclude/rule/bysetpos Optional (0 or 1) BYSETPOS rule
/appt/inv/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.
/appt/inv/comp/recur/add/exclude/rule/wkst Optional (0 or 1) Week start day - SU,MO,TU,WE,TH,FR,SA
/appt/inv/comp/recur/add/exclude/rule/wkst@day Required (only 1) Type:String
Weekday - SU|MO|TU|WE|TH|FR|SA
/appt/inv/comp/recur/add/exclude/rule/rule-x-name Optional (0 or more) X Name rules
/appt/inv/comp/recur/add/exclude/rule/rule-x-name@name Optional (0 or 1) Type:String
XNAME Name
/appt/inv/comp/recur/add/exclude/rule/rule-x-name@value Optional (0 or 1) Type:String
XNAME Value
/appt/inv/comp/recur/add/except Optional (0 or 1) See /appt/inv/comp/recur/add/exclude/except for more details.
/appt/inv/comp/recur/add/cancel Optional (0 or 1) See /appt/inv/comp/recur/add/exclude/cancel for more details.
/appt/inv/comp/recur/add/dates Optional (0 or 1) See /appt/inv/comp/recur/add/exclude/dates for more details.
/appt/inv/comp/recur/add/rule Optional (0 or 1) See /appt/inv/comp/recur/add/exclude/rule for more details.
/appt/inv/comp/recur/exclude Optional (0 or 1) See /appt/inv/comp/recur/add/exclude for more details.
/appt/inv/comp/recur/except Optional (0 or 1) See /appt/inv/comp/recur/add/exclude/except for more details.
/appt/inv/comp/recur/cancel Optional (0 or 1) See /appt/inv/comp/recur/add/exclude/cancel for more details.
/appt/inv/comp/recur/dates Optional (0 or 1) See /appt/inv/comp/recur/add/exclude/dates for more details.
/appt/inv/comp/recur/rule Optional (0 or 1) See /appt/inv/comp/recur/add/exclude/rule for more details.
/appt/inv/comp/exceptId Optional (0 or 1) RECURRENCE-ID, if this is an exception
/appt/inv/comp/exceptId@d Required (only 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
 
/appt/inv/comp/exceptId@tz Optional (0 or 1) Type:String
Java timezone identifier
/appt/inv/comp/exceptId@rangeType Optional (0 or 1) Type:Integer
Range type - 1 means NONE, 2 means THISANDFUTURE, 3 means THISANDPRIOR
/appt/inv/comp/s Optional (0 or 1) Start date-time (required)
See /appt/inv/comp/recur/add/exclude/dates/dtval/s for more details.
/appt/inv/comp/e Optional (0 or 1) End date-time
See /appt/inv/comp/recur/add/exclude/dates/dtval/s for more details.
/appt/inv/comp/dur Optional (0 or 1) Duration
See /appt/inv/comp/alarm/trigger/rel for more details.
/appt/inv/mp Optional (0 or 1)
/appt/inv/mp@part Required (only 1) Type:String
MIME part name. "" means top-level part, 1 first part, 1.1 first part of a multipart inside of 1.
/appt/inv/mp@ct Required (only 1) Type:String
MIME Content-Type. The mime type is the content of the element.
/appt/inv/mp@s Optional (0 or 1) Type:Integer
Size in bytes
/appt/inv/mp@cd Optional (0 or 1) Type:String
MIME Content-Disposition
/appt/inv/mp@filename Optional (0 or 1) Type:String
Filename attribute from the Content-Disposition param list
/appt/inv/mp@ci Optional (0 or 1) Type:String
MIME Content-ID (for display of embedded images)
/appt/inv/mp@cl Optional (0 or 1) Type:String
MIME/Microsoft Content-Location (for display of embedded images)
/appt/inv/mp@body Optional (0 or 1) Type:0|1
Set if this part is considered to be the "body" of the message for display purposes.
/appt/inv/mp@truncated Optional (0 or 1) Type:0|1
Set if the content for the part is truncated
/appt/inv/mp/content Optional (0 or 1) Type:{content} (String)
The content of the part, if requested
/appt/inv/mp/mp Optional (0 or more) Mime parts
See /appt/inv/mp for more details.
/appt/inv/shr Optional (0 or 1)
/appt/inv/shr@truncated Optional (0 or 1) Type:0|1
Truncated flag
/appt/inv/shr/content Optional (0 or 1) Type:{content} (String)
Content
/appt/inv/dlSubs Optional (0 or 1)
/appt/inv/dlSubs@truncated Optional (0 or 1) Type:0|1
Truncated flag
/appt/inv/dlSubs/content Optional (0 or 1) Type:{content} (String)
Content
/appt/replies Required (only 1)
/appt/replies/reply Optional (0 or more)
/appt/replies/reply@seq Required (only 1) Type:int
Sequence number
/appt/replies/reply@d Required (only 1) Type:long
DTSTAMP date in milliseconds
/appt/replies/reply@at Required (only 1) Type:String
Attendee address
/appt/replies/reply@sentBy Optional (0 or 1) Type:String
iCalendar SENT-BY
/appt/replies/reply@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/replies/reply@rangeType Required (only 1) Type:int
Recurrence range type
/appt/replies/reply@recurId Required (only 1) Type:String
Recurrence ID in format : YYMMDD[THHMMSS[Z]]
/appt/replies/reply@tz Optional (0 or 1) Type:String
Timezone name
/appt/replies/reply@ridZ Optional (0 or 1) Type:String
Recurrence-id in UTC time zone; used in non-all-day appointments only
Format: YYMMDDTHHMMSSZ
/appt/meta Optional (0 or more) Metadata
/appt/meta@section Optional (0 or 1) Type:String
Section.
Normally present. If absent this indicates that CustomMetadata info is present but there are no sections to report on.
/appt/meta/a Optional (0 or more) Type:{value}
Key value pairs
Description for element text content:Value
/appt/meta/a@n Required (only 1) Type:String
Key
/task Optional (0 or 1)
/task@f Optional (0 or 1) Type:String
Flags
/task@t Optional (0 or 1) Type:String
Tags - Comma separated list of integers. DEPRECATED - use "tn" instead
/task@tn Optional (0 or 1) Type:String
Comma separated list of tag names
/task@uid Optional (0 or 1) Type:String
iCalendar UID
/task@id Optional (0 or 1) Type:String
Appointment ID
/task@rev Optional (0 or 1) Type:Integer
Revision number
/task@s Optional (0 or 1) Type:Long
Size
/task@d Optional (0 or 1) Type:Long
Date
/task@l Optional (0 or 1) Type:String
Folder ID
/task@md Optional (0 or 1) Type:Long
Modified date in seconds
/task@ms Optional (0 or 1) Type:Integer
Modified sequence
/task@nextAlarm Optional (0 or 1) Type:Long
Next alarm time
/task@orphan Optional (0 or 1) Type:0|1
Has exceptions but no series
/task/inv Optional (0 or more) Invites
See /appt/inv for more details.
/task/replies Required (only 1)
/task/replies/reply Optional (0 or more) See /appt/replies/reply for more details.
/task/meta Optional (0 or more) Metadata
See /appt/meta for more details.