Share via

2.2.4.6 t:CalendarItemType Complex Type

  • Article

The CalendarItemType complex type represents a server calendar item. This complex type extends the ItemType complex type, as specified in [MS-OXWSCORE] section 2.2.4.24.

 <xs:complexType name="CalendarItemType">
     <xs:complexContent>
       <xs:extension base="t:ItemType">
         <xs:sequence>
           <!-- iCalendar properties -->
           <xs:element name="UID" type="xs:string" minOccurs="0"/>
           <xs:element name="RecurrenceId" type="xs:dateTime" minOccurs="0"/>
           <xs:element name="DateTimeStamp" type="xs:dateTime" minOccurs="0"/>
           <!-- Single and Occurrence only -->
           <xs:element name="Start" type="xs:dateTime" minOccurs="0"/>
           <xs:element name="End" type="xs:dateTime" minOccurs="0"/>
           <!-- Occurrence only -->
           <xs:element name="OriginalStart" type="xs:dateTime" minOccurs="0"/>
           <xs:element name="IsAllDayEvent" type="xs:boolean" minOccurs="0"/>
           <xs:element name="LegacyFreeBusyStatus" type="t:LegacyFreeBusyType" minOccurs="0"/>
           <xs:element name="Location" type="xs:string" minOccurs="0"/>
           <xs:element name="When" type="xs:string" minOccurs="0"/>
           <xs:element name="IsMeeting" type="xs:boolean" minOccurs="0"/>
           <xs:element name="IsCancelled" type="xs:boolean" minOccurs="0"/>
           <xs:element name="IsRecurring" type="xs:boolean" minOccurs="0"/>
           <xs:element name="MeetingRequestWasSent" type="xs:boolean" minOccurs="0"/>
           <xs:element name="IsResponseRequested" type="xs:boolean" minOccurs="0"/>
           <xs:element name="CalendarItemType" type="t:CalendarItemTypeType" minOccurs="0"/>
           <xs:element name="MyResponseType" type="t:ResponseTypeType" minOccurs="0"/>
           <xs:element name="Organizer" type="t:SingleRecipientType" minOccurs="0"/>
           <xs:element name="RequiredAttendees" type="t:NonEmptyArrayOfAttendeesType" minOccurs="0"/>
           <xs:element name="OptionalAttendees" type="t:NonEmptyArrayOfAttendeesType" minOccurs="0"/>
           <xs:element name="Resources" type="t:NonEmptyArrayOfAttendeesType" minOccurs="0"/>
           <!-- Conflicting and adjacent meetings -->
           <xs:element name="ConflictingMeetingCount" type="xs:int" minOccurs="0"/>
           <xs:element name="AdjacentMeetingCount" type="xs:int" minOccurs="0"/>
           <xs:element name="ConflictingMeetings" type="t:NonEmptyArrayOfAllItemsType" minOccurs="0"/>
           <xs:element name="AdjacentMeetings" type="t:NonEmptyArrayOfAllItemsType" minOccurs="0"/>
           <xs:element name="Duration" type="xs:string" minOccurs="0"/>
           <xs:element name="TimeZone" type="xs:string" minOccurs="0"/>
           <xs:element name="AppointmentReplyTime" type="xs:dateTime" minOccurs="0"/>
           <xs:element name="AppointmentSequenceNumber" type="xs:int" minOccurs="0"/>
           <xs:element name="AppointmentState" type="xs:int" minOccurs="0"/>
           <!-- Recurrence specific data, only valid if CalendarItemType is RecurringMaster -->
           <xs:element name="Recurrence" type="t:RecurrenceType" minOccurs="0"/>
           <xs:element name="FirstOccurrence" type="t:OccurrenceInfoType" minOccurs="0"/>
           <xs:element name="LastOccurrence" type="t:OccurrenceInfoType" minOccurs="0"/>
           <xs:element name="ModifiedOccurrences" type="t:NonEmptyArrayOfOccurrenceInfoType" minOccurs="0"/>
           <xs:element name="DeletedOccurrences" type="t:NonEmptyArrayOfDeletedOccurrencesType" minOccurs="0"/>
           <xs:element name="MeetingTimeZone" type="t:TimeZoneType" minOccurs="0"/>
           <xs:element name="StartTimeZone" type="t:TimeZoneDefinitionType" minOccurs="0"/>
           <xs:element name="EndTimeZone" type="t:TimeZoneDefinitionType" minOccurs="0"/>
           <xs:element name="ConferenceType" type="xs:int" minOccurs="0"/>
           <xs:element name="AllowNewTimeProposal" type="xs:boolean" minOccurs="0"/>
           <xs:element name="IsOnlineMeeting" type="xs:boolean" minOccurs="0"/>
           <xs:element name="MeetingWorkspaceUrl" type="xs:string" minOccurs="0"/>
           <xs:element name="NetShowUrl" type="xs:string" minOccurs="0"/>
           <xs:element name="EnhancedLocation" type="t:EnhancedLocationType" minOccurs="0"/>
           <xs:element name="StartWallClock" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
           <xs:element name="EndWallClock" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
           <xs:element name="StartTimeZoneId" type="xs:string" minOccurs="0" maxOccurs="1"/>
           <xs:element name="EndTimeZoneId" type="xs:string" minOccurs="0" maxOccurs="1"/>
           <xs:element name="IntendedFreeBusyStatus" type="t:LegacyFreeBusyType" minOccurs="0" />
           <xs:element name="JoinOnlineMeetingUrl" type="xs:string" minOccurs="0" maxOccurs="1" />
           <xs:element name="OnlineMeetingSettings" type="t:OnlineMeetingSettingsType" minOccurs="0" maxOccurs="1"/>
           <xs:element name="IsOrganizer" type="xs:boolean" minOccurs="0"/>
           <xs:element name="InboxReminders" type="t:ArrayOfInboxReminderType" minOccurs="0"/>
         </xs:sequence>
       </xs:extension>
     </xs:complexContent>
   </xs:complexType>
 

The following table lists the child elements of the CalendarItemType complex type.

Element name

Type

Description

UID

xs:string ([XMLSCHEMA2])

Contains the unique identifier for the calendar item.

RecurrenceId

xs:dateTime ([XMLSCHEMA2])

Specifies a specific instance of a recurring calendar item. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

DateTimeStamp

xs:dateTime

Specifies the date and time that the calendar item was created. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

Start

xs:dateTime

Specifies the start date and time of a duration.

End

xs:dateTime

Specifies the end date and time of a duration.

OriginalStart

xs:dateTime

Represents the original start time of a calendar item (only for occurrences/exceptions). This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

IsAllDayEvent

xs:boolean ([XMLSCHEMA2])

Indicates whether a calendar item or meeting request represents an all-day event.

LegacyFreeBusyStatus

t:LegacyFreeBusyType ([MS-OXWSCDATA] section 2.2.5.17)

Specifies the free/busy status of the calendar item.

Location

xs:string

Specifies the location of a meeting or appointment.

When

xs:string

Provides information about when a calendar or meeting item occurs and is not populated to attendee's mailbox.

IsMeeting

xs:boolean

Indicates whether the calendar item is a meeting or an appointment. "true" if the calendar item is a meeting, otherwise the calendar item is an appointment. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

IsCancelled

xs:boolean

Indicates whether a meeting has been canceled. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

IsRecurring

xs:boolean

Indicates whether a calendar item is part of a recurring item. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

MeetingRequestWasSent

xs:boolean

Indicates whether a meeting request has been sent to requested attendees, including required and optional attendees, and resources. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

IsResponseRequested

xs:boolean

Indicates whether a response to an item is requested.

CalendarItemType

t:CalendarItemTypeType (section 2.2.5.2)

Specifies the occurrence type of a calendar item. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

MyResponseType

t:ResponseTypeType (section 2.2.5.12)

Specifies the status of the response to a calendar item. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

Organizer

t:SingleRecipientType ([MS-OXWSCDATA] section 2.2.4.69)

Specifies the organizer of a meeting. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

RequiredAttendees

t:NonEmptyArrayOfAttendeesType (section 2.2.4.19)

Specifies attendees that are required to attend a meeting.

OptionalAttendees

t:NonEmptyArrayOfAttendeesType

Specifies attendees who are not required to attend a meeting.

Resources

t:NonEmptyArrayOfAttendeesType

Specifies a scheduled resource for a meeting and is not populated to attendee's mailbox.

ConflictingMeetingCount

xs:int ([XMLSCHEMA2])

Specifies the number of meetings that conflict with the calendar item.

AdjacentMeetingCount

xs:int

Indicates the total number of calendar items that are adjacent to a meeting time.

ConflictingMeetings

t:NonEmptyArrayOfAllItemsType ([MS-OXWSCDATA] section 2.2.4.46)

Indicates all calendar items that conflict with a meeting time.

AdjacentMeetings

t:NonEmptyArrayOfAllItemsType ([MS-OXWSCDATA] section 2.2.4.46)

Indicates all calendar items that are adjacent to a meeting time.

Duration

xs:string

Specifies the duration of a calendar item. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

TimeZone

xs:string

Specifies a text description of a time zone.<12> This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

AppointmentReplyTime

xs:dateTime

Specifies the date and time that an attendee replied to a meeting request. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

AppointmentSequenceNumber

xs:int

Specifies the sequence number of a version of an appointment. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

AppointmentState

xs:int

Specifies the status of the appointment. Valid values include:

§ 0 (zero): the calendar item represents an appointment

§ 1: the calendar item on the organizer's calendar represents a meeting

§ 3: the meeting request corresponding to the calendar item has been received

§ 5: the meeting corresponding to the organizer's calendar item has been cancelled. This value is found in the Deleted Items folder of the organizer.

§ 7: the meeting corresponding to the attendee's calendar item has been cancelled

This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

Recurrence

t:RecurrenceType (section 2.2.4.25)

Specifies the recurrence pattern and the recurrence range for calendar items and meeting requests.

FirstOccurrence

t:OccurrenceInfoType (section 2.2.4.22)

Specifies the first occurrence of a recurring calendar item. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

LastOccurrence

t:OccurrenceInfoType

Specifies the last occurrence of a recurring calendar item. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

ModifiedOccurrences

t:NonEmptyArrayOfOccurrenceInfoType (section 2.2.4.21)

Specifies recurring calendar item occurrences that have been modified so that they differ from original occurrences (or instances of the recurring master item). This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

DeletedOccurrences

t:NonEmptyArrayOfDeletedOccurrencesType (section 2.2.4.20)

Specifies deleted occurrences of a recurring calendar item. This element is not valid if CalendarItemType is contained in a CreateItem request, as specified in section 3.1.4.2.

MeetingTimeZone

t:TimeZoneType (section 2.2.4.29)

MAY<13> specify the time zone of the location where the meeting is hosted. This element is returned only if the value of the CalendarItemType element is RecurringMaster.

StartTimeZone

t:TimeZoneDefinitionType ([MS-OXWSGTZ] section 2.2.4.12)

SHOULD<14> specify the calendar item start time zone information.

EndTimeZone

t:TimeZoneDefinitionType

SHOULD<15> specify the calendar item end time zone information.

ConferenceType

xs:int

Specifies the type of conferencing that is performed with a calendar item.<16> Valid values include:

§ 0 (zero): video conference

§ 1: presentation

§ 2: chat

AllowNewTimeProposal

xs:boolean

Indicates whether a new meeting time can be proposed for a meeting by an attendee.

IsOnlineMeeting

xs:boolean

Indicates whether the meeting is online. This element is read-only.<17>

MeetingWorkspaceUrl

xs:string

Contains the URL for the Meeting Workspace that is included in the calendar item.

NetShowUrl

xs:string

Specifies the URL for an online meeting.

EnhancedLocation

t:EnhancedLocationType (section 2.2.4.12)

Specifies additional location information for the calendar item.<18>

StartWallClock

xs:dateTime

Specifies the start time of the calendar item.<19>

EndWallClock

xs:dateTime

Specifies the ending time of the calendar item.<20>

StartTimeZoneId

xs:string

Specifies the calendar item start time zone identifier.<21>

EndTimeZoneId

xs:string

Specifies the calendar item end time zone identifier.<22>

IntendedFreeBusyStatus

t:LegacyFreeBusyType ([MS-OXWSCDATA] section 2.2.5.17)

Indicates how the organizer of the meeting wants it to show up in the attendee's calendar when the meeting is accepted. <23>

JoinOnlineMeetingUrl

xs:string

Specifies the URL for joining the online meeting.<24> This element is ignored by the server.

OnlineMeetingSettings

t:OnlineMeetingSettingsType (section 2.2.4.23)

Specifies settings for online meetings.<25> This element is ignored by the server.

IsOrganizer

xs:boolean

Specifies whether the current user is the organizer and/or owner of the calendar item.<26>

InboxReminders

t:ArrayOfInboxReminderType (section 2.2.4.3)

Specifies Inbox reminders.