[MS-QSSWS]:
Search Query Shared Services Protocol
Intellectual Property Rights Notice for Open Specifications Documentation
Technical Documentation. Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions.
Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation.
No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.
Patents. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft Open Specifications Promise or the Microsoft Community Promise. If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting .
License Programs. To see all of the protocols in scope under a specific license program and the associated patents, visit the Patent Map.
Trademarks. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit
Fictitious Names. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.
Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise.
Tools. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it.
Support. For questions and support, please contact .
Revision Summary
Date / Revision History / Revision Class / Comments7/13/2009 / 0.1 / Major / Initial Availability
8/28/2009 / 0.2 / Editorial / Revised and edited the technical content
11/6/2009 / 0.3 / Editorial / Revised and edited the technical content
2/19/2010 / 1.0 / Minor / Updated the technical content
3/31/2010 / 1.01 / Editorial / Revised and edited the technical content
4/30/2010 / 1.02 / Editorial / Revised and edited the technical content
6/7/2010 / 1.03 / Editorial / Revised and edited the technical content
6/29/2010 / 1.04 / Editorial / Changed language and formatting in the technical content.
7/23/2010 / 1.05 / Minor / Clarified the meaning of the technical content.
9/27/2010 / 1.05 / None / No changes to the meaning, language, or formatting of the technical content.
11/15/2010 / 1.05 / None / No changes to the meaning, language, or formatting of the technical content.
12/17/2010 / 1.05 / None / No changes to the meaning, language, or formatting of the technical content.
3/18/2011 / 1.05 / None / No changes to the meaning, language, or formatting of the technical content.
6/10/2011 / 1.05 / None / No changes to the meaning, language, or formatting of the technical content.
1/20/2012 / 2.0 / Major / Significantly changed the technical content.
4/11/2012 / 2.0 / None / No changes to the meaning, language, or formatting of the technical content.
7/16/2012 / 2.0 / None / No changes to the meaning, language, or formatting of the technical content.
9/12/2012 / 2.0 / None / No changes to the meaning, language, or formatting of the technical content.
10/8/2012 / 2.0.1 / Editorial / Changed language and formatting in the technical content.
2/11/2013 / 2.0.2 / Editorial / Changed language and formatting in the technical content.
7/30/2013 / 3.0 / Major / Significantly changed the technical content.
11/18/2013 / 3.0 / None / No changes to the meaning, language, or formatting of the technical content.
2/10/2014 / 3.1 / Minor / Clarified the meaning of the technical content.
4/30/2014 / 3.2 / Minor / Clarified the meaning of the technical content.
7/31/2014 / 3.3 / Minor / Clarified the meaning of the technical content.
10/30/2014 / 3.4 / Minor / Clarified the meaning of the technical content.
2/26/2016 / 4.0 / Major / Significantly changed the technical content.
7/15/2016 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
9/14/2016 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
6/20/2017 / 5.0 / Major / Significantly changed the technical content.
11/3/2017 / 6.0 / Major / Significantly changed the technical content.
12/12/2017 / 7.0 / Major / Significantly changed the technical content.
Table of Contents
1Introduction
1.1Glossary
1.2References
1.2.1Normative References
1.2.2Informative References
1.3Overview
1.4Relationship to Other Protocols
1.5Prerequisites/Preconditions
1.6Applicability Statement
1.7Versioning and Capability Negotiation
1.8Vendor-Extensible Fields
1.9Standards Assignments
2Messages
2.1Transport
2.2Common Message Syntax
2.2.1Namespaces
2.2.2Messages
2.2.3Elements
2.2.4Complex Types
2.2.4.1PagingCookie
2.2.4.2ArrayOfanyType
2.2.4.3ArrayOfstring
2.2.4.4AlertInfo
2.2.4.5DataBuffer
2.2.4.6DateRefinementInterval
2.2.4.7FullTextSqlQueryProperties
2.2.4.8HighlightedString
2.2.4.9NumericRefinementInterval
2.2.4.10QueryPersonalizationData
2.2.4.11QueryProperties
2.2.4.12AggregatedOMQueryLatencyDataBuffer
2.2.4.13AggregatedUIQueryLatencyDataBuffer
2.2.4.14ArrayOfKeyValueOfintAggregatedOMQueryLatencyDataBuffer_PFsic3Az
2.2.4.15ArrayOfKeyValueOfstringAggregatedOMQueryLatencyDataBuffer_PFsic3Az
2.2.4.16ArrayOfKeyValueOfstringAggregatedUIQueryLatencyDataBuffer_PFsic3Az
2.2.4.17ArrayOfKeyValueOfstringArrayOfKeyValueOfintAggregatedOMQueryLatencyDataBuffer_PFsic3Azty7Ep6D1
2.2.4.18ArrayOfKeyValueOfstringanyType
2.2.4.19ArrayOfKeyValueOfstringVerboseOMQueryLatencyDataBuffer_PFsic3Az
2.2.4.20ArrayOfKeyValueOfstringVerboseUIQueryLatencyDataBuffer_PFsic3Az
2.2.4.21ArrayOfVerboseQueryErrorDataBuffer
2.2.4.22ArrayOfVerboseWebPartQueryLatencyDataBuffer
2.2.4.23OMQueryLatencyDataBuffer
2.2.4.24QueryDataBufferBaseOfAggregatedOMQueryLatencyDataBufferVerboseOMQueryLatencyDataBufferYrv50AqE
2.2.4.25QueryDataBufferBaseOfAggregatedUIQueryLatencyDataBufferVerboseUIQueryLatencyDataBufferYrv50AqE
2.2.4.26QueryErrorDataBuffer
2.2.4.27UIQueryLatencyDataBuffer
2.2.4.28VerboseOMQueryLatencyDataBuffer
2.2.4.29VerboseQueryErrorDataBuffer
2.2.4.30VerboseUIQueryLatencyDataBuffer
2.2.4.31VerboseWebPartQueryLatencyDataBuffer
2.2.4.32WebPartQueryLatencyDataBuffer
2.2.4.33ArrayOfAggregatedOMQueryLatencyDataBuffer
2.2.4.34ArrayOfAggregatedUIQueryLatencyDataBuffer
2.2.4.35ArrayOfboolean
2.2.4.36ArrayOfint
2.2.4.37ArrayOfKeyValueOfstringstring
2.2.4.38ArrayOfVerboseOMQueryLatencyDataBuffer
2.2.4.39ArrayOfVerboseUIQueryLatencyDataBuffer
2.2.4.40QueryHealthMonitoringSettings
2.2.4.41SharedSearchBoxSettings
2.2.5Simple Types
2.2.5.1AlertChangeType
2.2.5.2KeywordInclusion
2.2.5.3QueryAuthenticationType
2.2.5.4QueryHint
2.2.5.5ResultType
2.2.5.6SearchProvider
2.2.5.7SPUrlZone
2.2.5.8guid
2.2.6Attributes
2.2.7Groups
2.2.8Attribute Groups
2.2.9Common Data Structures
3Protocol Details
3.1Server Details
3.1.1Abstract Data Model
3.1.1.1Object Hierarchy
3.1.1.2Search Service Application Information
3.1.1.3Managed Property Information
3.1.1.4Scope Information
3.1.1.5Query Monitoring Information
3.1.1.6Query logging
3.1.2Timers
3.1.3Initialization
3.1.4Message Processing Events and Sequencing Rules
3.1.4.1Execute
3.1.4.1.1Messages
3.1.4.1.1.1ISearchQueryServiceApplication_Execute_InputMessage
3.1.4.1.1.2ISearchQueryServiceApplication_Execute_OutputMessage
3.1.4.1.2Elements
3.1.4.1.2.1Execute
3.1.4.1.2.2ExecuteResponse
3.1.4.1.3Complex Types
3.1.4.1.3.1ResultTableCollection
3.1.4.1.3.2ArrayOfResultDefinition
3.1.4.1.3.3ResultDefinition
3.1.4.1.3.4KeywordInformation
3.1.4.1.3.5ArrayOfKeyValueOfResultTypeResultTableUTLV0zE5
3.1.4.1.3.6ResultTable
3.1.4.1.3.7ArrayOfKeyValuePairOfstringResultTable_PFsic3Az
3.1.4.1.3.8KeyValuePairOfstringResultTable_PFsic3Az
3.1.4.1.3.9ArrayOfKeyValueOfstringSearchServiceApplicationFaulty6h3NzC8
3.1.4.1.3.10SearchServiceApplicationFault
3.1.4.1.4Simple Types
3.1.4.1.4.1SearchServiceApplicationFaultType
3.1.4.1.5Attributes
3.1.4.1.6Groups
3.1.4.1.7Attribute Groups
3.1.4.2GetClickFrequenciesForUrl
3.1.4.2.1Messages
3.1.4.2.1.1ISearchQueryServiceApplication_GetClickFrequenciesForUrl_InputMessage
3.1.4.2.1.2ISearchQueryServiceApplication_GetClickFrequenciesForUrl_OutputMessage
3.1.4.2.2Elements
3.1.4.2.2.1GetClickFrequenciesForUrl
3.1.4.2.2.2GetClickFrequenciesForUrlResponse
3.1.4.2.3Complex Types
3.1.4.2.4Simple Types
3.1.4.2.5Attributes
3.1.4.2.6Groups
3.1.4.2.7Attribute Groups
3.1.4.3GetProperties
3.1.4.3.1Messages
3.1.4.3.1.1ISearchQueryServiceApplication_GetProperties_InputMessage
3.1.4.3.1.2ISearchQueryServiceApplication_GetProperties_OutputMessage
3.1.4.3.2Elements
3.1.4.3.2.1GetProperties
3.1.4.3.2.2GetPropertiesResponse
3.1.4.3.3Complex Types
3.1.4.3.3.1ArrayOfPropertyInformation
3.1.4.3.3.2PropertyInformation
3.1.4.3.4Simple Types
3.1.4.3.5Attributes
3.1.4.3.6Groups
3.1.4.3.7Attribute Groups
3.1.4.4GetQuerySuggestions
3.1.4.4.1Messages
3.1.4.4.1.1ISearchQueryServiceApplication_GetQuerySuggestions_InputMessage
3.1.4.4.1.2ISearchQueryServiceApplication_GetQuerySuggestions_OutputMessage
3.1.4.4.2Elements
3.1.4.4.2.1GetQuerySuggestions
3.1.4.4.2.2GetQuerySuggestionsResponse
3.1.4.4.3Complex Types
3.1.4.4.4Simple Types
3.1.4.4.5Attributes
3.1.4.4.6Groups
3.1.4.4.7Attribute Groups
3.1.4.5GetScopes
3.1.4.5.1Messages
3.1.4.5.1.1ISearchQueryServiceApplication_GetScopes_InputMessage
3.1.4.5.1.2ISearchQueryServiceApplication_GetScopes_OutputMessage
3.1.4.5.2Elements
3.1.4.5.2.1GetScopes
3.1.4.5.2.2GetScopesResponse
3.1.4.5.3Complex Types
3.1.4.5.3.1ArrayOfScopeInformation
3.1.4.5.3.2ScopeInformation
3.1.4.5.4Simple Types
3.1.4.5.4.1ScopeCompilationState
3.1.4.5.5Attributes
3.1.4.5.6Groups
3.1.4.5.7Attribute Groups
3.1.4.6GetSearchServiceApplicationInfo
3.1.4.6.1Messages
3.1.4.6.1.1ISearchQueryServiceApplication_GetSearchServiceApplicationInfo_InputMessage
3.1.4.6.1.2ISearchQueryServiceApplication_GetSearchServiceApplicationInfo_OutputMessage
3.1.4.6.2Elements
3.1.4.6.2.1GetSearchServiceApplicationInfo
3.1.4.6.2.2GetSearchServiceApplicationInfoResponse
3.1.4.6.3Complex Types
3.1.4.6.3.1SearchServiceApplicationInfo
3.1.4.6.4Simple Types
3.1.4.6.5Attributes
3.1.4.6.6Groups
3.1.4.6.7Attribute Groups
3.1.4.7GetSearchTerms
3.1.4.7.1Messages
3.1.4.7.1.1ISearchQueryServiceApplication_GetSearchTerms_InputMessage
3.1.4.7.1.2ISearchQueryServiceApplication_GetSearchTerms_OutputMessage
3.1.4.7.2Elements
3.1.4.7.2.1GetSearchTerms
3.1.4.7.2.2GetSearchTermsResponse
3.1.4.7.3Complex Types
3.1.4.7.3.1KeywordQueryProperties
3.1.4.7.3.2ArrayOfKeyValueOfstringArrayOfRefinementInterval_PFsic3Az
3.1.4.7.3.3ArrayOfRefinementInterval
3.1.4.7.3.4SortCollection
3.1.4.7.3.5ArrayOfSort
3.1.4.7.3.6Sort
3.1.4.7.3.7ReorderingRuleCollection
3.1.4.7.3.8ArrayOfReorderingRule
3.1.4.7.3.9ReorderingRule
3.1.4.7.3.10RefinementInterval
3.1.4.7.4Simple Types
3.1.4.7.4.1SpellcheckMode
3.1.4.7.4.2ResubmitFlag
3.1.4.7.4.3SimilarType
3.1.4.7.4.4SortDirection
3.1.4.7.4.5ReorderingRuleMatchType
3.1.4.7.5Attributes
3.1.4.7.6Groups
3.1.4.7.7Attribute Groups
3.1.4.8GetTopQueryStringsForUrl
3.1.4.8.1Messages
3.1.4.8.1.1ISearchQueryServiceApplication_GetTopQueryStringsForUrl_InputMessage
3.1.4.8.1.2ISearchQueryServiceApplication_GetTopQueryStringsForUrl_OutputMessage
3.1.4.8.2Elements
3.1.4.8.2.1GetTopQueryStringsForUrl
3.1.4.8.2.2GetTopQueryStringsForUrlResponse
3.1.4.8.3Complex Types
3.1.4.8.4Simple Types
3.1.4.8.5Attributes
3.1.4.8.6Groups
3.1.4.8.7Attribute Groups
3.1.4.9HighlightStringValue
3.1.4.9.1Messages
3.1.4.9.1.1ISearchQueryServiceApplication_HighlightStringValue_InputMessage
3.1.4.9.1.2ISearchQueryServiceApplication_HighlightStringValue_OutputMessage
3.1.4.9.2Elements
3.1.4.9.2.1HighlightStringValue
3.1.4.9.2.2HighlightStringValueResponse
3.1.4.9.3Complex Types
3.1.4.9.4Simple Types
3.1.4.9.5Attributes
3.1.4.9.6Groups
3.1.4.9.7Attribute Groups
3.1.4.10HighlightStringValueQuerySuggestions
3.1.4.10.1Messages
3.1.4.10.1.1ISearchQueryServiceApplication_HighlightStringValueQuerySuggestions_InputMessage
3.1.4.10.1.2ISearchQueryServiceApplication_HighlightStringValueQuerySuggestions_OutputMessage
3.1.4.10.2Elements
3.1.4.10.2.1HighlightStringValueQuerySuggestions
3.1.4.10.2.2HighlightStringValueQuerySuggestionsResponse
3.1.4.10.3Complex Types
3.1.4.10.4Simple Types
3.1.4.10.5Attributes
3.1.4.10.6Groups
3.1.4.10.7Attribute Groups
3.1.4.11RecordClick
3.1.4.11.1Messages
3.1.4.11.1.1ISearchQueryServiceApplication_RecordClick_InputMessage
3.1.4.11.1.2ISearchQueryServiceApplication_RecordClick_OutputMessage
3.1.4.11.2Elements
3.1.4.11.2.1RecordClick
3.1.4.11.2.2RecordClickResponse
3.1.4.11.3Complex Types
3.1.4.11.3.1QueryInfo
3.1.4.11.4Simple Types
3.1.4.11.4.1QueryLogClientType
3.1.4.11.4.2QueryLogType
3.1.4.11.5Attributes
3.1.4.11.6Groups
3.1.4.11.7Attribute Groups
3.1.4.12RecordOMQueryDoneEvent
3.1.4.12.1Messages
3.1.4.12.1.1ISearchQueryServiceApplication_RecordOMQueryDoneEvent_InputMessage
3.1.4.12.1.2ISearchQueryServiceApplication_RecordOMQueryDoneEvent_OutputMessage
3.1.4.12.2Elements
3.1.4.12.2.1RecordOMQueryDoneEvent
3.1.4.12.2.2RecordOMQueryDoneEventResponse
3.1.4.12.3Complex Types
3.1.4.12.4Simple Types
3.1.4.12.5Attributes
3.1.4.12.6Groups
3.1.4.12.7Attribute Groups
3.1.4.13RecordQueryErrorEvent
3.1.4.13.1Messages
3.1.4.13.1.1ISearchQueryServiceApplication_RecordQueryErrorEvent_InputMessage
3.1.4.13.1.2ISearchQueryServiceApplication_RecordQueryErrorEvent_OutputMessage
3.1.4.13.2Elements
3.1.4.13.2.1RecordQueryErrorEvent
3.1.4.13.2.2RecordQueryErrorEventResponse
3.1.4.13.3Complex Types
3.1.4.13.4Simple Types
3.1.4.13.5Attributes
3.1.4.13.6Groups
3.1.4.13.7Attribute Groups
3.1.4.14RecordUIQueryDoneEvent
3.1.4.14.1Messages
3.1.4.14.1.1ISearchQueryServiceApplication_RecordUIQueryDoneEvent_InputMessage
3.1.4.14.1.2ISearchQueryServiceApplication_RecordUIQueryDoneEvent_OutputMessage
3.1.4.14.2Elements
3.1.4.14.2.1RecordUIQueryDoneEvent
3.1.4.14.2.2RecordUIQueryDoneEventResponse
3.1.4.14.3Complex Types
3.1.4.14.4Simple Types
3.1.4.14.5Attributes
3.1.4.14.6Groups
3.1.4.14.7Attribute Groups
3.1.4.15RecordWebPartQueryDoneEvent
3.1.4.15.1Messages
3.1.4.15.1.1ISearchQueryServiceApplication_RecordWebPartQueryDoneEvent_InputMessage
3.1.4.15.1.2ISearchQueryServiceApplication_RecordWebPartQueryDoneEvent_OutputMessage
3.1.4.15.2Elements
3.1.4.15.2.1RecordWebPartQueryDoneEvent
3.1.4.15.2.2RecordWebPartQueryDoneEventResponse
3.1.4.15.3Complex Types
3.1.4.15.4Simple Types
3.1.4.15.5Attributes
3.1.4.15.6Groups
3.1.4.15.7Attribute Groups
3.1.4.16RecordPageClick
3.1.4.16.1Messages
3.1.4.16.1.1ISearchQueryServiceApplication_RecordPageClick_InputMessage
3.1.4.16.1.2ISearchQueryServiceApplication_RecordPageClick_OutputMessage
3.1.4.16.2Elements
3.1.4.16.2.1RecordPageClick
3.1.4.16.2.2RecordPageClickResponse
3.1.4.16.3Complex Types
3.1.4.16.3.1QueryLogPageClick
3.1.4.16.3.2QueryLogImmediacyInfo
3.1.4.16.4Simple Types
3.1.4.16.4.1QueryLogClickType
3.1.4.16.5Attributes
3.1.4.16.6Groups
3.1.4.16.7Attribute Groups
3.1.4.17GetQueryHealthMonitoringSettings
3.1.4.17.1Messages
3.1.4.17.1.1ISearchHealthMonitoringServiceApplication_GetQueryHealthMonitoringSettings_InputMessage
3.1.4.17.1.2ISearchHealthMonitoringServiceApplication_GetQueryHealthMonitoringSettings_OutputMessage
3.1.4.17.2Elements
3.1.4.17.2.1GetQueryHealthMonitoringSettings
3.1.4.17.2.2GetQueryHealthMonitoringSettingsResponse
3.1.4.17.3Complex Types
3.1.4.17.4Simple Types
3.1.4.17.5Attributes
3.1.4.17.6Groups
3.1.4.17.7Attribute Groups
3.1.4.18GetQuerySuggestionsWithResults
3.1.4.18.1Messages
3.1.4.18.1.1ISearchQueryServiceApplication_GetQuerySuggestionsWithResults_InputMessage
3.1.4.18.1.2ISearchQueryServiceApplication_GetQuerySuggestionsWithResults_OutputMessage
3.1.4.18.2Elements
3.1.4.18.2.1GetQuerySuggestionsWithResults
3.1.4.18.2.2GetQuerySuggestionsWithResultsResponse
3.1.4.18.3Complex Types
3.1.4.18.3.1QuerySuggestionResults
3.1.4.18.3.2ArrayOfPersonalResultSuggestion
3.1.4.18.3.3PersonalResultSuggestion
3.1.4.18.3.4ArrayOfQuerySuggestionQuery
3.1.4.18.3.5QuerySuggestionQuery
3.1.4.18.4Simple Types
3.1.4.18.5Attributes
3.1.4.18.6Groups
3.1.4.18.7Attribute Groups
3.1.4.19GetQueryHealthMonitoringSettingsForComponents
3.1.4.19.1Messages
3.1.4.19.1.1ISearchHealthMonitoringServiceApplication_GetQueryHealthMonitoringSettingsForComponents_InputMessage
3.1.4.19.1.2ISearchHealthMonitoringServiceApplication_GetQueryHealthMonitoringSettingsForComponents_OutputMessage
3.1.4.19.2Elements
3.1.4.19.2.1GetQueryHealthMonitoringSettingsForComponents
3.1.4.19.2.2GetQueryHealthMonitoringSettingsForComponentsResponse
3.1.4.19.3Complex Types
3.1.4.19.3.1ArrayOfKeyValueOfstringQueryHealthMonitoringSettingsvvncQr8z
3.1.4.19.4Simple Types
3.1.4.19.5Attributes
3.1.4.19.6Groups
3.1.4.19.7Attribute Groups
3.1.4.20RecordOMQueryDone
3.1.4.20.1Messages
3.1.4.20.1.1ISearchHealthMonitoringServiceApplication_RecordOMQueryDone_InputMessage
3.1.4.20.1.2ISearchHealthMonitoringServiceApplication_RecordOMQueryDone_OutputMessage
3.1.4.20.2Elements
3.1.4.20.2.1RecordOMQueryDone
3.1.4.20.2.2RecordOMQueryDoneResponse
3.1.4.20.3Complex Types
3.1.4.20.4Simple Types
3.1.4.20.5Attributes
3.1.4.20.6Groups
3.1.4.20.7Attribute Groups
3.1.4.21RecordQueryError
3.1.4.21.1Messages
3.1.4.21.1.1ISearchHealthMonitoringServiceApplication_RecordQueryError_InputMessage
3.1.4.21.1.2ISearchHealthMonitoringServiceApplication_RecordQueryError_OutputMessage
3.1.4.21.2Elements
3.1.4.21.2.1RecordQueryError
3.1.4.21.2.2RecordQueryErrorResponse
3.1.4.21.3Complex Types
3.1.4.21.4Simple Types
3.1.4.21.5Attributes
3.1.4.21.6Groups
3.1.4.21.7Attribute Groups
3.1.4.22RecordUIQueryDone
3.1.4.22.1Messages
3.1.4.22.1.1ISearchHealthMonitoringServiceApplication_RecordUIQueryDone_InputMessage
3.1.4.22.1.2ISearchHealthMonitoringServiceApplication_RecordUIQueryDone_OutputMessage
3.1.4.22.2Elements
3.1.4.22.2.1RecordUIQueryDone
3.1.4.22.2.2RecordUIQueryDoneResponse
3.1.4.22.3Complex Types
3.1.4.22.4Simple Types
3.1.4.22.5Attributes
3.1.4.22.6Groups
3.1.4.22.7Attribute Groups
3.1.4.23RecordWebPartQueryDone
3.1.4.23.1Messages
3.1.4.23.1.1ISearchHealthMonitoringServiceApplication_RecordWebPartQueryDone_InputMessage
3.1.4.23.1.2ISearchHealthMonitoringServiceApplication_RecordWebPartQueryDone_OutputMessage
3.1.4.23.2Elements
3.1.4.23.2.1RecordWebPartQueryDone
3.1.4.23.2.2RecordWebPartQueryDoneResponse
3.1.4.23.3Complex Types
3.1.4.23.4Simple Types
3.1.4.23.5Attributes
3.1.4.23.6Groups
3.1.4.23.7Attribute Groups
3.1.4.24GetImsEndpointAddresses
3.1.4.24.1Messages
3.1.4.24.1.1ISearchQueryServiceApplication_GetImsEndpointAddresses_InputMessage
3.1.4.24.1.2ISearchQueryServiceApplication_GetImsEndpointAddresses_OutputMessage
3.1.4.24.2Elements
3.1.4.24.2.1GetImsEndpointAddresses
3.1.4.24.2.2GetImsEndpointAddressesResponse
3.1.4.24.3Complex Types
3.1.4.24.3.1ArrayOfanyURI
3.1.4.24.4Simple Types
3.1.4.24.5Attributes
3.1.4.24.6Groups
3.1.4.24.7Attribute Groups
3.1.4.25GetQueryCompletions
3.1.4.25.1Messages
3.1.4.25.1.1ISearchQueryServiceApplication_GetQueryCompletions_InputMessage
3.1.4.25.1.2ISearchQueryServiceApplication_GetQueryCompletions_OutputMessage
3.1.4.25.2Elements
3.1.4.25.2.1GetQueryCompletions
3.1.4.25.2.2GetQueryCompletionsResponse
3.1.4.25.3Complex Types
3.1.4.25.3.1ArrayOfQueryAutoCompletion
3.1.4.25.3.2ArrayOfQueryAutoCompletionMatch
3.1.4.25.3.3QueryAutoCompletion
3.1.4.25.3.4QueryAutoCompletionMatch
3.1.4.25.3.5QueryAutoCompletionResults
3.1.4.25.4Simple Types
3.1.4.25.5Attributes
3.1.4.25.6Groups
3.1.4.25.7Attribute Groups
3.1.4.26IsUrlMappingCached
3.1.4.26.1Messages
3.1.4.26.1.1ISearchQueryServiceApplication_IsUrlMappingCached_InputMessage
3.1.4.26.1.2ISearchQueryServiceApplication_IsUrlMappingCached_OutputMessage
3.1.4.26.2Elements
3.1.4.26.2.1IsUrlMappingCached
3.1.4.26.2.2IsUrlMappingCachedResponse
3.1.4.26.3Complex Types
3.1.4.26.4Simple Types
3.1.4.26.5Attributes
3.1.4.26.6Groups
3.1.4.26.7Attribute Groups
3.1.5Timer Events
3.1.6Other Local Events
4Protocol Examples
4.1Issue a Search Query
4.2Retrieve Information About the Available Search Scopes
4.3Notify the Occurrence of a Clickthrough
4.4Obtain the Click Frequency for a Given URI
5Security
5.1Security Considerations for Implementers
5.2Index of Security Parameters
6Appendix A: Full WSDL
7Appendix B: Full XML Schema
7.1 Schema
7.2 Schema
7.3 Schema
7.4 Schema
7.5 Schema
7.6 Schema
7.7 Schema
7.8 Schema
7.9 Schema
7.10 Schema
8Appendix C: Product Behavior
9Change Tracking
10Index
1Introduction
The Search Query Shared Services Protocol enables the protocol client to retrieve search results and related information from the protocol server and to inform the protocol server about usage information.
Sections 1.5, 1.8, 1.9, 2, and 3 of this specification are normative. All other sections and examples in this specification are informative.
1.1Glossary
This document uses the following terms:
alert subscription: A request to receive an Internet message automatically when user-defined criteria are met. Such messages are generated automatically when items such as documents, webpages, list items, sites, or other resources on a server are changed.
alternate access mapping: A mapping of URLs to web applications. Incoming alternate access mappings are used to provide multiple URL entry points for the same set of content. Outgoing alternate access mappings are used to ensure that content is rendered in the correct URL context.
application server: A computer that provides infrastructure and services for applications that are hosted on a server farm.
ascending order: A sort order in which text strings are arranged in alphabetical order, numerical values are arranged from smallest to largest, and dates and times are arranged from oldest to newest.
best bet: A URL that a site collection administrator assigns to a keyword as being relevant for that keyword. See also visual best bet.
clickthrough: The process of navigating from one Internet resource to another.
compatibility mode: A mode in which hardware or software in one system or product version supports operations from another system or product version.
context: A collection of context properties that describe an execution environment.
contextual search scope: A system-defined restriction that can optionally be added to a query to restrict the query results to items that are from a specific site or list.
cookie: A small data file that is stored on a user's computer and carries state information between participating protocol servers and protocol clients.
Coordinated Universal Time (UTC): A high-precision atomic time standard that approximately tracks Universal Time (UT). It is the basis for legal, civil time all over the Earth. Time zones around the world are expressed as positive and negative offsets from UTC. In this role, it is also referred to as Zulu time (Z) and Greenwich Mean Time (GMT). In these specifications, all references to UTC refer to the time at UTC-0 (or GMT).
descending order: A sort order in which text strings are arranged in reverse alphabetical order, numerical values are arranged from largest to smallest, and dates and times are arranged from newest to oldest.
discovery center: See discovery console.
duplicate: A search result that is identified as having identical or near identical content.
duplicate result removal: An operation to compare the similarity of items and remove duplicates from search results.
electronic discovery (eDiscovery): A type of legal discovery that focuses on electronic (computer) communications and files.
empty GUID: A 128-bit, 16-byte identification number that is represented by all zeros.
empty string: A string object or variable that is initialized with the value "".
extracted definition: The definition that is obtained by an index server during a crawl to determine if any sentences in the item match the pattern for defining a term.
federated location: A source that returns search results for a search query. The source can be a local search catalog or an OpenSearch1.0/1.1-compliant search engine, as described in [OpenSearch1.1-Draft3].
front-end web server: A server that hosts webpages, performs processing tasks, and accepts requests from protocol clients and sends them to the appropriate back-end server for further processing.
full-text index catalog: A collection of full-text index components and other files that are organized in a specific directory structure and contain the data that is needed to perform queries.
globally unique identifier (GUID): A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. Specifically, the use of this term does not imply or require that the algorithms described in [RFC4122] or [C706] must be used for generating the GUID. See also universally unique identifier (UUID).
high confidence results: A subset of search results that are considered to be highly relevant because of a precise match between a high confidence property value and the tokens in the query text.
host name: The name of a physical server, as described in [RFC952].
Hypertext Markup Language (HTML): An application of the Standard Generalized Markup Language (SGML) that uses tags to mark elements in a document, as described in [HTML].
index partition: A part of an inverted index within a search system. In Microsoft Search Server 2010 and Microsoft Office SharePoint Server 2007 for Search, it is defined by a set of document distribution identifiers. In Microsoft FAST Search Server 2010, it is defined by a search index within an index column and can be divided into additional index partitions.
inflectional form: A variant of a root token that has been modified according to the linguistic rules of a given language. For example, inflections of the verb "swim" in English include "swim," "swims," "swimming," and "swam."
JavaScript Object Notation (JSON): A text-based, data interchange format that is used to transmit structured data, typically in Asynchronous JavaScript + XML (AJAX) web applications, as described in [RFC7159]. The JSON format is based on the structure of ECMAScript (Jscript, JavaScript) objects.
keyword: One or more words or phrases that site administrators identified as important for a search service application. A keyword provides a way to apply business rules to search results for queries that use the keyword.
keyword query: Query text that contains a property restriction and a corresponding property value.
keyword synonym: An alternate phrasing of a specific keyword. When users search for a keyword synonym, the search results include the same best bet results as for the keyword.
language code identifier (LCID): A 32-bit number that identifies the user interface human language dialect or variation that is supported by an application or a client computer.
list: A container within a SharePoint site that stores list items. A list has a customizable schema that is composed of one or more fields.
local search scope: An administrator-defined restriction that can optionally be added to a query to restrict the query results to items that are from a specific SharePoint site collection, site, or list.
managed property: A specific property that is part of a metadata schema. It can be exposed for use in search queries that are executed from the user interface.
metadata index: A data structure that is stored on a back-end database server. It stores properties that are associated with each item, and the attributes of those properties.
noise word: See stop word.
object model: A collection of object-oriented APIs that represent data structures and are designed to promote software interoperability.
page impression: An identifier for unique query text.
pluggable security authentication: The ability to support alternate mechanisms for determining the identity of another entity.
post-query suggestions: An alternative search query that is related to the search query that was executed.
pre-query suggestions: A search query that is related to the search query that the user is typing.
query logging: The process of recording information about user searches, such as search terms and time of access.
query result: A result that is returned for a query. It contains the title and URL of the item, and can also contain other managed properties and a hit-highlighted summary.
query rule: A setting that consists of a keyword condition and an action preformed to provide the most relevant search results.
query text: The textual, string portion of a query.
query throttling: A mechanism that helps all queries get their fair share of computational resources.
query transform: A query processing stage in which query text is examined and possibly modified to optimize query results. Examples of modifications are applying synonym settings or stemming expansion rules to the text.
ranking model: In a search query, a set of weights and numerical parameters that are used to compute a ranking score for each item. All items share the same ranking model for a specific set of search results. See also rank.
refinement bin: A set of data that is returned with query results and represents a statistical distribution of those results. The data is based on values of the managed property with which a refiner is associated.
refinement token: A Base-64 encoded string that represents a single refinement modifier that can be used to refine a search query. The string includes the name of the refiner, refinement name, and refinement value.
refinement value: A string that stores a value or numeric range that can be used to refine query results.
refiner: A configuration that is used for query refinement and is associated with one managed property.
request message: A Traversal Using Relay NAT (TURN) message that is sent from a protocol client to a protocol server.
response message: A Traversal Using Relay NAT (TURN) message that is sent from a protocol server to a protocol client in response to a request message. It is sent when the request message is handled successfully by the protocol server.
result provider: A component or application that serves a query to a search provider and translates the resulting data into a result set.
result set: A list of records that results from running a stored procedure or query, or applying a filter. The structure and content of the data in a result set varies according to the implementation.
result source: A local or remote search catalog, a remote Exchange search endpoint or an OpenSearch1.0/1.1-compliant search engine that may include a list of attributes that defines a set of search results for a search query.
search alert: An Internet message that is sent to subscribers automatically for a specific query. It notifies subscribers when one or more new results exist, or an existing result was modified.
search application: A unique group of search settings that is associated, one-to-one, with a shared service provider.
search index: A set of data structures that facilitates query evaluation by a search service application. The primary part of a search index is an inverted index of terms.
search provider: A component or application that provides data in response to a query. See also result provider.
search query: A complete set of conditions that are used to generate search results, including query text, sort order, and ranking parameters.
search query log: A record of information about user searches, such as search terms and time of access.
search scope: A list of attributes that define a collection of items.