Excel Add-In for Microsoft Exchange

Build 25.0.9434

CalendarView

Returns a collection of calendar events—such as occurrences, exceptions, and single instances—within a specified time window. This is useful for generating user-defined calendar views across various calendar types.

Table Specific Information

Select

Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's. By default only the event occurrences from the user's default calendar in the range of the last 30 days are returned. You can filter results by CalendarId, Start_DateTime, End_DateTime.

For example the following queries are processed server-side:

SELECT * FROM CalendarView WHERE Start_DateTime >= '2019-12-10 15:00' AND End_DateTime <= '2020-01-10 14:30'

SELECT * FROM CalendarView WHERE CalendarId = 'AQMkAGRlMWQ5MDg0LWI5ZTQtNDk2Yi1hOTQ1LTU4YzFmMzEwZjlhMgBGAAAD-FjxR3cIwE6TEGSCVtIHcwcAQyR2Iw3coEOaUD1BLt0tnAAAAwcAAABDJHYjDdygQ5pQPUEu3S2cAAACC_IAAAA='

NOTE Unless specifying the AlwaysRequestTableDependencies connection property or selecting/filtering by the reference column CalendarId, the value for CalendarId remains null.

Columns

Name Type Description
id [KEY] String Unique identifier for the calendar event. This ID is used to reference the event in API calls and operations.
categories String Comma-separated list of user-defined categories that classify the event. Categories help with organizing and filtering calendar items.
changeKey String A version identifier for the event that changes whenever the event is updated. Used for concurrency control.
createdDateTime Datetime Timestamp indicating when the event was initially created in the calendar system.
lastModifiedDateTime Datetime Timestamp showing the last time the event details were updated or modified.
attendees String Comma-separated list of attendees invited to the event. Each entry includes participant details such as name, email, and type.
body_contentType String Specifies the format of the event body content. Typical values include 'text' or 'html'.
body_content String The full content of the event body or description, provided in the format specified by the body_contentType.
bodyPreview String A plain-text preview of the event body. This field offers a truncated version of the content for quick display or summary.
end_dateTime String The date and time at which the event is scheduled to end, formatted as an ISO 8601 string.
end_timeZone String Time zone that applies to the event's end time, such as 'Pacific Standard Time' or 'UTC'.
hasAttachments Bool Indicates whether the event includes file attachments or related documents.
iCalUId String The unique identifier of the event as defined by the iCalendar standard. Useful for synchronization with external calendar systems.
importance String Indicates the perceived priority of the event. Typical values include 'low', 'normal', and 'high'.
isAllDay Bool Specifies whether the event spans the entire day without a specific start or end time.
isCancelled Bool Indicates whether the event has been canceled. A canceled event can still appear in calendars depending on context.
isOrganizer Bool True if the current user is the organizer of the event. Determines permission levels and allowed actions.
isReminderOn Bool Indicates whether a reminder is set for the event. Reminders trigger notifications before the event starts.
location_displayName String The display name of the event location, typically a room name or venue title.
location_locationEmailAddress String Email address associated with the physical location, often used for booking rooms or resources.
location_address_street String Street address portion of the event location.
location_address_city String City in which the event is taking place.
location_address_state String State or province of the event location, if applicable.
location_address_countryOrRegion String Country or region in which the event is located.
location_address_postalCode String Specifies the postal code component of the physical address where the calendar event is scheduled to occur. Useful for geolocation and regional context.
location_coordinates_altitude Double Indicates the vertical elevation of the location, measured in meters above sea level, which can be used in mapping or navigation scenarios.
location_coordinates_latitude Double Represents the geographic latitude of the event location using decimal degrees. This value is used to place the location on a map.
location_coordinates_longitude Double Represents the geographic longitude of the event location using decimal degrees. Used with latitude to pinpoint the exact location.
location_coordinates_accuracy Double Measures the level of accuracy, in meters, for the provided geographic coordinates. A lower value indicates higher precision.
location_coordinates_altitudeAccuracy Double Denotes the degree of uncertainty, in meters, associated with the altitude value. Useful for assessing the reliability of vertical positioning.
location_locationUri String Contains a URI or URL that can represent additional metadata or external reference for the location, such as a map link or booking page.
location_locationType String Specifies the type of location, such as 'conferenceRoom', 'homeAddress', or 'businessAddress'. Helps determine the nature of the event venue.
location_uniqueId String Stores a unique identifier associated with the location, which can be used for cross-referencing or integration with other systems.
location_uniqueIdType String Describes the type of unique identifier for the location, such as a directory object ID or custom external ID. Helps in resolving the location from different sources.
locations String Provides a comma-separated list of location names or descriptors associated with the event. May include primary and additional locations.
onlineMeetingUrl String Contains the URL link to an online meeting platform (such as Teams or Zoom) for virtual participation in the event.
organizer_emailAddress_name String Represents the display name of the event organizer as shown in the calendar invitation.
organizer_emailAddress_address String Holds the email address of the organizer responsible for creating or managing the calendar event.
originalEndTimeZone String Specifies the time zone that was originally used for the event's end time before any updates. Helps in historical tracking and time conversions.
originalStart Datetime Indicates the original start date and time of the event, before any modifications were made. Useful for auditing changes.
originalStartTimeZone String Represents the time zone associated with the original start time of the event, aiding in accurate scheduling across regions.
recurrence_pattern_type String Defines the recurrence pattern type for repeating events, such as 'daily', 'weekly', 'monthly', or 'yearly'. Supports recurring event logic.
recurrence_pattern_interval Int Specifies the frequency at which the event recurs, such as every 1 week or every 2 months. This value represents the interval between occurrences, based on the recurrence pattern type.
recurrence_pattern_month Int Indicates the month of the year in which the recurring event occurs when the recurrence pattern is yearly and the month is explicitly defined.
recurrence_pattern_dayOfMonth Int Defines the specific day of the month on which the recurring event is scheduled, used in monthly or yearly recurrence patterns.
recurrence_pattern_daysOfWeek String Lists the days of the week on which the event recurs, separated by commas with no spaces. Valid values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday.
recurrence_pattern_firstDayOfWeek String Defines the first day of the week used in the recurrence pattern calculation. Common values are Sunday or Monday, depending on regional or organizational settings.
recurrence_pattern_index String Specifies the position of the day within the month for recurrence, such as first, second, third, fourth, or last. Used in patterns like 'the second Tuesday of each month.'
recurrence_range_type String Describes the type of recurrence range, such as a fixed number of occurrences, an end date, or no end date (infinite recurrence). Common values include numbered, endDate, and noEnd.
recurrence_range_startDate Date Indicates the starting date of the recurrence range, which marks when the repeating event begins.
recurrence_range_endDate Date Indicates the end date of the recurrence range, after which no further recurrences will be scheduled.
recurrence_range_recurrenceTimeZone String Defines the time zone context for the recurrence pattern, which affects how start and end times are interpreted across time zones.
recurrence_range_numberOfOccurrences Int Specifies the total number of times the event should occur within the recurrence range. Used when the recurrence is based on a fixed number of repetitions.
reminderMinutesBeforeStart Int Indicates the number of minutes before the start time at which a reminder is set to alert the user about the event.
responseRequested Bool Indicates whether attendees are requested to send a response to the invitation, such as accepting, declining, or marking as tentative.
responseStatus_response String Reflects the current response status of the attendee, with possible values such as accepted, declined, tentative, or none.
responseStatus_time Datetime Specifies the timestamp at which the attendee's response status was last updated.
sensitivity String Denotes the sensitivity level of the event, such as normal, personal, private, or confidential, which affects how it is displayed to others.
seriesMasterId String References the unique identifier of the series master item when the current item is an occurrence or exception in a recurring series.
showAs String Specifies how the event appears on the calendar, such as free, tentative, busy, or out of office, affecting availability status.
start_dateTime String Contains the start date and time of the event instance, formatted as an ISO 8601 string.
start_timeZone String Specifies the time zone in which the event's start_dateTime is defined, ensuring accurate scheduling across regions.
subject String Contains the title or subject line of the calendar event, typically shown in calendar views and event summaries.
type String Indicates the type of calendar item, such as singleInstance, occurrence, exception, or seriesMaster, which reflects its role in recurring events.
webLink String Provides a direct URL link to view the calendar event in a web browser interface, typically for web-based calendar clients.
calendarId String Identifies the calendar to which the event belongs, used to associate the event with a specific calendar container or owner.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434