Share via

3.1.4.2.3.2 m:FindItemType Complex Type

  • Article

The FindItemType complex type specifies the search criteria to use for the FindItem operation. The FindItemType complex type extends the BaseRequestType complex type ([MS-OXWSCDATA] section 2.2.4.17).

 <xs:complexType name="FindItemType">
   <xs:complexContent>
     <xs:extension
       base="m:BaseRequestType"
     >
       <xs:sequence>
         <xs:element name="ItemShape"
           type="t:ItemResponseShapeType"
          />
         <xs:choice
           minOccurs="0"
         >
           <xs:element name="IndexedPageItemView"
             type="t:IndexedPageViewType"
            />
           <xs:element name="FractionalPageItemView"
             type="t:FractionalPageViewType"
            />
           <xs:element name="CalendarView"
             type="t:CalendarViewType"
            />
           <xs:element name="ContactsView"
             type="t:ContactsViewType"
            />
         </xs:choice>
         <xs:choice
           minOccurs="0"
         >
           <xs:element name="GroupBy"
             type="t:GroupByType"
            />
           <xs:element name="DistinguishedGroupBy"
             type="t:DistinguishedGroupByType"
            />
         </xs:choice>
         <xs:element name="Restriction"
           type="t:RestrictionType"
           minOccurs="0"
          />
         <xs:element name="SortOrder"
           type="t:NonEmptyArrayOfFieldOrdersType"
           minOccurs="0"
          />
         <xs:element name="ParentFolderIds"
           type="t:NonEmptyArrayOfBaseFolderIdsType"
          />
         <xs:element name="QueryString"
           type="xs:QueryStringType"
           minOccurs="0"
          />
       </xs:sequence>
       <xs:attribute name="Traversal"
         type="t:ItemQueryTraversalType" use="required"
        />
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>
 

The following table lists the child elements of the FindItemType complex type

Element

Type

Description

ItemShape

t:ItemResponseShapeType ([MS-OXWSCDATA] section 2.2.4.42)

Specifies the array of items that are returned by the query.

IndexedPageItemView

t:IndexedPageViewType (section 2.2.4.16)

Specifies how paged item information is returned in the response.

FractionalPageItemView

t:FractionalPageViewType (section 2.2.4.14)

Specifies the starting item and number of items to return by the query.

CalendarView

t:CalendarViewType ([MS-OXWSMTGS] section 2.2.4.9)

Specifies the settings that are used to return calendar items as they appear in a calendar.

ContactsView

t:ContactsViewType ([MS-OXWSCONT] section 3.1.4.1.1.7)

Specifies the settings that are used to return contact items based on their alphabetical display names.

GroupBy

t:GroupByType (section 3.1.4.2.3.7)

Specifies the grouping for items that are returned by a query.

DistinguishedGroupBy

t:DistinguishedGroupByType (section 3.1.4.2.3.5)

Specifies a standard grouping.

Restriction

t:RestrictionType (section 2.2.4.30)

Specifies a search restriction or query.

SortOrder

t:NonEmptyArrayOfFieldOrdersType (section 3.1.4.2.3.8)

Specifies one or more FieldOrderType complex type (section 3.1.4.2.3.6) elements that specify how the results should be sorted.

ParentFolderIds

t:NonEmptyArrayOfBaseFolderIdsType ([MS-OXWSFOLD] section 3.1.4.6.3.3)

Specifies one or more folders that are the root of the search.

QueryString<18>

m:QueryStringType (section 2.2.4.29)

Specifies the query that is used for the search.

The following table lists the attribute that is defined for the FindItemType complex type.

Attribute

Type

Description

Traversal

t:ItemQueryTraversalType (section 2.2.5.7)

Specifies whether the search finds items in folders or in the Deleted Items folder.

The FindItemType complex type specifies the search criteria to find a set of items by using the FindItem operation as well as the structure of the response.

One of the following elements can be included in the request to specify how the returned items are viewed.

  • IndexedPageItemView

  • FractionalPageItemView

  • CalendarView

  • ContactsView

One of the following elements can be included in the request to specify how the results, if any, are to be grouped:

  • GroupBy

  • DistinguishedGroupBy

When the subelement BaseShape of the ItemShape element is set to "AllProperties" or "Default", the properties that are returned by the FindItem operation depend on the folder that is searched for the items. The properties that are returned are defined by the complex type element or combination of complex type elements that represent the item stored in the folder, as shown in the following table.<19>

Folder

Complex type

Calendar

CalendarItemType ([MS-OXWSMTGS] section 2.2.4.6).

Contacts

ContactItemType ([MS-OXWSCONT] section 2.2.4.3).

DistributionListType ([MS-OXWSDLIST] section 2.2.4.1).

Folder

MessageType ([MS-OXWSMSG] section 2.2.4.3).

PostItemType ([MS-OXWSPOST] section 2.2.4.1).

MeetingCancellationMessageType ([MS-OXWSMTGS] section 2.2.4.14).

MeetingMessageType ([MS-OXWSMTGS] section 2.2.4.15).

MeetingRequestMessageType ([MS-OXWSMTGS] section 2.2.4.17).

MeetingResponseMessageType ([MS-OXWSMTGS] section 2.2.4.18).

Search

CalendarItemType ([MS-OXWSMTGS] section 2.2.4.6).

ContactItemType ([MS-OXWSCONT] section 2.2.4.3).

DistributionListType ([MS-OXWSDLIST] section 2.2.4.1).

MessageType ([MS-OXWSMSG] section 2.2.4.3).

PostItemType ([MS-OXWSPOST] section 2.2.4.1).

MeetingCancellationMessageType ([MS-OXWSMTGS] section 2.2.4.14).

MeetingMessageType ([MS-OXWSMTGS] section 2.2.4.15).

MeetingRequestMessageType ([MS-OXWSMTGS] section 2.2.4.17).

MeetingResponseMessageType ([MS-OXWSMTGS] section 2.2.4.18).

TaskType  ([MS-OXWSTASK] section 2.2.4.6).

Tasks

TaskType ([MS-OXWSTASK] section 2.2.4.6).