Share via

4.1 Obtain Information about Server Search Scopes

  • Article

The protocol client might request information about the protocol server’s search scopes by sending a request such as this one:

 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
   <soap12:Body>
     <GetPortalSearchInfo xmlns="http://microsoft.com/webservices/OfficeServer/QueryService" />
   </soap12:Body>
 </soap12:Envelope>

The protocol server might respond with a message such as this one:

 <?xml version="1.0" encoding="utf-8"?>
 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
     <GetPortalSearchInfoResponse xmlns="http://microsoft.com/webservices/OfficeServer/QueryService">
       <GetPortalSearchInfoResult>&lt;SiteConfigInfo xmlns="urn:Microsoft.MSSearch.Response.Config"&gt;&lt;Name&gt;MCtest&lt;/Name&gt;&lt;Id&gt;{556f4ae3-17eb-44dc-8aa4-9e7a7e512e69}&lt;/Id&gt;&lt;Scopes&gt;&lt;Scope&gt;&lt;Name&gt;People&lt;/Name&gt;&lt;/Scope&gt;&lt;Scope&gt;&lt;Name&gt;All Sites&lt;/Name&gt;&lt;/Scope&gt;&lt;Scope&gt;&lt;Name&gt;Global Query Exclusion&lt;/Name&gt;&lt;/Scope&gt;&lt;Scope&gt;&lt;Name&gt;Rank Demoted Sites&lt;/Name&gt;&lt;/Scope&gt;&lt;/Scopes&gt;&lt;/SiteConfigInfo&gt;</GetPortalSearchInfoResult>
     </GetPortalSearchInfoResponse>
   </soap:Body>
 </soap:Envelope>

The request information in the preceding message is doubly encoded XML. The following shows the decoded value of the GetPortalSearchInfoResult string:

 <SiteConfigInfo xmlns="urn:Microsoft.MSSearch.Response.Config">
   <Name>MCtest</Name>
   <Id>{556f4ae3-17eb-44dc-8aa4-9e7a7e512e69}</Id>
   <Scopes>
     <Scope>
       <Name>People</Name>
     </Scope>
     <Scope>
       <Name>All Sites</Name>
     </Scope>
     <Scope>
       <Name>Global Query Exclusion</Name>
     </Scope>
     <Scope>
       <Name>Rank Demoted Sites</Name>
     </Scope>
   </Scopes>
 </SiteConfigInfo>