3.1.4.2.3.13 SearchResultsType Complex Type

  • Article

The SearchResultsType complex type represents a set of search results.

   <xs:complexType name="SearchResultsType">
     <xs:sequence>
       <xs:element name="Items" minOccurs="0" maxOccurs="1">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="Item" type="t:ItemType" minOccurs="0" maxOccurs="unbounded"/>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
       <xs:element name="Conversations" minOccurs="0" maxOccurs="1">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="Conversation" type="t:ConversationType" minOccurs="0" maxOccurs="unbounded"/>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
       <xs:element name="People" minOccurs="0" maxOccurs="1">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="Persona" type="t:PersonaType" minOccurs="0" maxOccurs="unbounded"/>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
       <xs:element name="MoreResultsAvailable" type="xs:boolean" minOccurs="1" maxOccurs="1" />
       <xs:element name="RefinerTelemetryBatchId" type="xs:int" minOccurs="1" maxOccurs="1"/>
       <xs:element name="SearchRefiners" minOccurs="0" maxOccurs="1">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="SearchRefiner" type="t:SearchRefinerType" minOccurs="1" maxOccurs="unbounded"/>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
       <xs:element name="DiagnosticsData" type="t:SearchDiagnosticsType" minOccurs="0" maxOccurs="1"/>
       <xs:element name="SearchResultsCount" type="xs:int" minOccurs="0" maxOccurs="1" />
       <xs:element name="TotalResultsCount" type="xs:int" minOccurs="0" maxOccurs="1" />
       <xs:element name="SearchTerms" type="t:ArrayOfStringsType" minOccurs="0" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>

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

Element name

Type

Description

Items

Sequence of t:ItemType ([MS-OXWSCORE] section 2.2.4.24)

Items that matched the query.

Conversations

Sequence of t:ConversationType ([MS-OXWSCONV] section 3.1.4.2.3.4)

Conversations that matched the query.

People

Sequence of t:PersonaType ([MS-OXWSPERS] section 2.2.4.19)

People that matched the query.

MoreResultsAvailable

xs:boolean ([XMLSCHEMA2/2])

true if more results matched the query than are contained in this set.

RefinerTelemetryBatchId

xs:int ([XMLSCHEMA2/2])

For internal use only.

SearchRefiners

Sequence of t:SearchRefinerType (section 3.1.4.2.3.12)

Dynamic refiners derived from the results.

DiagnosticsData

t:SearchDiagnosticsType (section 2.2.4.1)

For internal use only.

SearchResultsCount

xs:int

The number of search results contained in this response.

TotalResultsCount

xs:int

The number of search results matching the query.

SearchTerms

t:ArrayOfStringsType ([MS-OXWSCDATA] section 2.2.4.13)

Returns the actual terms used for the search, after word breaking and removal of any syntax-related property names. Intended for use by clients that wish to perform hit highlighting