3.1.4.3.3.1 GetSearchSuggestions Complex Type

  • Article

The GetSearchSuggestions complex type specifies a request for search suggestions. This complex type extends the BaseRequestType complex type, as specified by .[MS-OXWSCDATA] section 2.2.4.17

   <xs:complexType name="GetSearchSuggestions">
     <xs:complexContent>
       <xs:extension base="m:BaseRequestType">
         <xs:sequence>
           <xs:element name="SearchSessionId" type="t:GuidType" minOccurs="1" maxOccurs="1" />
           <xs:element name="Query" type="xs:string" minOccurs="0" maxOccurs="1" />
           <xs:element name="SuggestionTypes" type="t:SuggestionKindType" minOccurs="0" maxOccurs="1" />
           <xs:element name="SuggestionsPrimer" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
           <xs:element name="MaxSuggestionsCountPerSuggestionType" type="xs:long" minOccurs="0" maxOccurs="1" />
         </xs:sequence>
       </xs:extension>
     </xs:complexContent>
   </xs:complexType>

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

Element

Type

Description

SearchSessionId

t:GuidType ([MS-OXWSXPROP] section 2.1.7)

Uniquely identifies this session. This SHOULD have been supplied to the StartSearchSession operation (section 3.1.4.4).

Query

xs:string ([XMLSCHEMA2/2])

A query, or query fragment: typically, the text that a user has entered as the search term(s). The server MUST try to match this against its available data sources, and return matching queries. The client can omit this, in which case the server will generate suggestions based on criteria other than string matching (for example, most recent queries).

SuggestionTypes

t:SuggestionKindType (section 2.2.5.1)

The type(s) of suggestions that are desired.

SuggestionsPrimer

xs:boolean ([XMLSCHEMA2/2])

For internal use only.

MaxSuggestionsCountPerSuggestionType

xs:long ([XMLSCHEMA2/2])

The greatest number of suggestions of any type (specified in the SuggestionTypes element) that the client wishes to receive. The server MUST NOT return more suggestions of any given type.