Article
08/21/2009

CalendarView

Topic Last Modified: 2006-06-11

The CalendarView element defines a FindItem Operation as returning calendar items in a set as they appear in a calendar.

Schema Hierarchy

FindItem
CalendarView

Syntax

<CalendarView MaxEntriesReturned="" StartDate="" EndDate="" />

Type

CalendarView

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
MaxEntriesReturned	Describes the maximum number of results to return in the FindItem response.
StartDate	Identifies the start of a time span queried for calendar items. All calendar items that have an end time that is before StartDate will not be returned. The value of StartDate can be specified in coordinated universal time (UTC) format, as in 2006-01-02T12:00:00Z, or in a format where local time and time zone offset is specified, as in 2006-01-02T04:00:00-08:00. This attribute is required.
EndDate	Identifies the end of a time span queried for calendar items. All calendar items that have a start time that is on or after EndDate will not be returned. The value of EndDate can be specified in UTC format, as in 2006-02-02T12:00:00Z, or in a format where local time and time zone offset is specified, as in 2006-02-02T04:00:00-08:00. EndDate must be greater than or equal to StartDate; otherwise an error is returned. This attribute is required.

MaxEntriesReturned

Describes the maximum number of results to return in the FindItem response.

StartDate

Identifies the start of a time span queried for calendar items. All calendar items that have an end time that is before StartDate will not be returned. The value of StartDate can be specified in coordinated universal time (UTC) format, as in 2006-01-02T12:00:00Z, or in a format where local time and time zone offset is specified, as in 2006-01-02T04:00:00-08:00.

This attribute is required.

EndDate

Identifies the end of a time span queried for calendar items. All calendar items that have a start time that is on or after EndDate will not be returned. The value of EndDate can be specified in UTC format, as in 2006-02-02T12:00:00Z, or in a format where local time and time zone offset is specified, as in 2006-02-02T04:00:00-08:00.

EndDate must be greater than or equal to StartDate; otherwise an error is returned. This attribute is required.

Child Elements

None.

Parent Elements

Element Description

Element	Description
FindItem	Defines a request to find items in a mailbox. The following is the XPath expression to this element: `/FindItem`

FindItem

Defines a request to find items in a mailbox.

The following is the XPath expression to this element:

/FindItem

Remarks

If the CalendarView element is specified in a FindItem request, the Web service returns a list of single calendar items and occurrences of recurring calendar items within the range specified by StartDate and EndDate.

If the CalendarView element is not specified in a FindItem request, the Web service returns a list of single calendar items and recurring master calendar items. Calendar occurrences of a recurring calendar item are not expanded.

The schema that describes this element is located in the EWS virtual directory of the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.

Example

The following example shows a FindItem request. A successful request returns a response that includes calendar items that started at 2006-05-18T00:00:00-08:00 or after and ended before 2006-05-19T00:00:00-08:00.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">
  <soap:Body>
    <FindItem Traversal="Shallow" xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <ItemShape>
        <t:BaseShape>IdOnly</t:BaseShape>
        <t:AdditionalProperties>
          <t:FieldURI FieldURI="calendar:Start"/>
          <t:FieldURI FieldURI="calendar:End"/>
          <t:FieldURI FieldURI="item:Subject"/>
        </t:AdditionalProperties>
      </ItemShape>
      <CalendarView MaxEntriesReturned="2" StartDate="2006-05-18T00:00:00-08:00" EndDate="2006-05-19T00:00:00-08:00"/>
      <ParentFolderIds>
        <t:DistinguishedFolderId Id="calendar"/>
      </ParentFolderIds>
    </FindItem>
  </soap:Body>
</soap:Envelope>

Element Information

Namespace	https://schemas.microsoft.com/exchange/services/2006/messages
Schema Name	Messages schema
Validation File	Messages.xsd
Can be Empty	False

Partager via