IndexedPageItemView

Topic Last Modified: 2006-06-12

The IndexedPageItemView element describes how paged item information is returned for a FindItem request.

Schema Hierarchy

FindItem
  IndexedPageItemView

Syntax

<IndexedPageViewItemView MaxEntriesReturned="" Offset="" BasePoint=" />

Type

IndexedPageViewType

Attributes and Elements

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

Attributes

Attribute	Description
MaxEntriesReturned	Describes the maximum number of items to return in the response. This attribute is optional.
Offset	Describes the offset from the BasePoint. If BasePoint is equal to Beginning, the offset is positive. If BasePoint is equal to End, the offset is handled as if it were negative. This identifies which item will be the first item delivered in the response. This attribute is required.
BasePoint	Describes whether the page of items will start from the beginning or the end of the set of items that are found by using the search criteria. Seeking from the end always searches backward. This attribute is required.

BasePoint Attribute

Value	Description
Beginning	The paged view starts at the beginning of the found item set.
End	The paged view starts at the end of the found item set.

Child Elements

None.

Parent Elements

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

Remarks

Seeking from the end involves moving to the origin identified by the offset. Additionally, the pointer is moved back by the number of requested records. For example, if there are 100 records and the offset is 25 from the end, the search starts from 75. If 10 records are returned, the pointer is moved backward an additional 10 records to 65 and returns records 65 through 75. The next index is 64. The next offset from the end for a page is 100 minus 64 which equals 36. 36 is the value for the next offset from the end to get the next indexed page.

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. Each item is returned with its ID and subject. A maximum of six items are returned in the response. The first six items are returned. They are listed in ascending order grouped by importance. Items in a group are aggregated by subject.

<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="item:Subject"/>
        </t:AdditionalProperties>
      </ItemShape>
      <IndexedPageItemView MaxEntriesReturned="6" BasePoint="Beginning" Offset="0" />
      <GroupBy Order="Ascending">
        <t:FieldURI FieldURI="item:Importance"/>
        <t:AggregateOn Aggregate="Maximum">
          <t:FieldURI FieldURI="item:Subject"/>
        </t:AggregateOn>
      </GroupBy>
      <ParentFolderIds>
        <t:DistinguishedFolderId Id="inbox"/>
      </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

See Also

Reference

FindItem Operation

Other Resources

Finding Items (Exchange Web Services)