4.1.6 GetScopesForConsumer

To retrieve information about all the search scopes associated to a given search scope consumer, the protocol client might send a message such as this one:

 <s:Envelope 
   xmlns:s="http://www.w3.org/2003/05/soap-envelope" 
   xmlns:a="http://www.w3.org/2005/08/addressing" 
   xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
     <a:Action s:mustUnderstand="1">
       http://tempuri.org/ISearchSiteAdministrationServiceApplication/GetScopesForConsumer
     </a:Action>
     <a:MessageID>
       urn:uuid:56ecf270-3a90-4a6d-bee1-89388ea7a338
     </a:MessageID>
     <a:ReplyTo>
       <a:Address>
         http://www.w3.org/2005/08/addressing/anonymous
       </a:Address>
     </a:ReplyTo>
     <ServiceContext 
       xmlns="http://schemas.microsoft.com/sharepoint/servicecontext" 
       xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
       <correlationId>
         8e2c202a-7ec3-4bfb-9922-e9bb0af57069
       </correlationId>
       <language>en-US</language>
       <region>en-US</region>
       <siteSubscriptionId>
         00000000-0000-0000-0000-000000000000
       </siteSubscriptionId>
     </ServiceContext>
     <a:To s:mustUnderstand="1" u:Id="_1">
       http://example.com:32843/dc46e19968e743728529b721db8c8c60/SearchService.svc
     </a:To>
   </s:Header>
   <s:Body>
     <GetScopesForConsumer xmlns="http://tempuri.org/">
       <consumerName>496f265c-4758-4ac5-b14d-d02dfa131a64</consumerName>
     </GetScopesForConsumer>
   </s:Body>
 </s:Envelope>

The protocol server might then respond with the following message:

 <s:Envelope 
   xmlns:s="http://www.w3.org/2003/05/soap-envelope" 
   xmlns:a="http://www.w3.org/2005/08/addressing" 
   xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
     <a:Action 
       s:mustUnderstand="1">
       http://tempuri.org/ISearchSiteAdministrationServiceApplication/GetScopesForConsumerResponse
     </a:Action>
     <ActivityId 
       CorrelationId="807a78b3-88c8-42c5-b420-1caa46038ba8" 
       xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">
       ed24ba4e-ab2f-4707-ae63-1a35248ba82f
     </ActivityId>
     <a:RelatesTo>
       urn:uuid:56ecf270-3a90-4a6d-bee1-89388ea7a338
     </a:RelatesTo>
   </s:Header>
   <s:Body>
     <GetScopesForConsumerResponse xmlns="http://tempuri.org/">
       <GetScopesForConsumerResult 
         xmlns:b="http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration" 
         xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <b:ScopeInfo>
           <b:AlternateResultsPage>peopleresults.aspx</b:AlternateResultsPage>
           <b:CompilationState>Compiled</b:CompilationState>
           <b:CompilationType>AlwaysCompile</b:CompilationType>
           <b:ConsumerName>496f265c-4758-4ac5-b14d-d02dfa131a64</b:ConsumerName>
           <b:Description>Search for people.</b:Description>
           <b:DisplayInAdminUI>true</b:DisplayInAdminUI>
           <b:Filter i:nil="true"></b:Filter>
           <b:Id>0</b:Id>
           <b:IsDeleted>false</b:IsDeleted>
           <b:LastCompilationTime>2010-01-08T18:00:56.317</b:LastCompilationTime>
           <b:LastModifiedBy>username</b:LastModifiedBy>
           <b:LastModifiedTime>2010-01-08T17:53:11.15</b:LastModifiedTime>
           <b:Name>People</b:Name>
           <b:SiteUrl i:nil="true"></b:SiteUrl>
         </b:ScopeInfo>
         <b:ScopeInfo>
           <b:AlternateResultsPage i:nil="true"></b:AlternateResultsPage>
           <b:CompilationState>Compiled</b:CompilationState>
           <b:CompilationType>AlwaysCompile</b:CompilationType>
           <b:ConsumerName>496f265c-4758-4ac5-b14d-d02dfa131a64</b:ConsumerName>
           <b:Description>Search for everything available for searching.</b:Description>
           <b:DisplayInAdminUI>true</b:DisplayInAdminUI>
           <b:Filter i:nil="true"></b:Filter>
           <b:Id>1</b:Id>
           <b:IsDeleted>false</b:IsDeleted>
           <b:LastCompilationTime>2010-01-08T18:00:56.317</b:LastCompilationTime>
           <b:LastModifiedBy>username</b:LastModifiedBy>
           <b:LastModifiedTime>2010-01-08T17:53:11.157</b:LastModifiedTime>
           <b:Name>All Sites</b:Name>
           <b:SiteUrl i:nil="true"></b:SiteUrl>
         </b:ScopeInfo>
         <b:ScopeInfo>
           <b:AlternateResultsPage i:nil="true"></b:AlternateResultsPage>
           <b:CompilationState>Empty</b:CompilationState>
           <b:CompilationType>AlwaysCompile</b:CompilationType>
           <b:ConsumerName>496f265c-4758-4ac5-b14d-d02dfa131a64</b:ConsumerName>
           <b:Description>Everything that is to be omitted from all searches by default.</b:Description>
           <b:DisplayInAdminUI>false</b:DisplayInAdminUI>
           <b:Filter i:nil="true"></b:Filter>
           <b:Id>2</b:Id>
           <b:IsDeleted>false</b:IsDeleted>
           <b:LastCompilationTime>0001-01-01T00:00:00</b:LastCompilationTime>
           <b:LastModifiedBy>username</b:LastModifiedBy>
           <b:LastModifiedTime>2010-01-08T17:53:11.16</b:LastModifiedTime>
           <b:Name>Global Query Exclusion</b:Name>
           <b:SiteUrl i:nil="true"></b:SiteUrl>
         </b:ScopeInfo>
         <b:ScopeInfo>
           <b:AlternateResultsPage i:nil="true"></b:AlternateResultsPage>
           <b:CompilationState>Empty</b:CompilationState>
           <b:CompilationType>AlwaysCompile</b:CompilationType>
           <b:ConsumerName>496f265c-4758-4ac5-b14d-d02dfa131a64</b:ConsumerName>
           <b:Description>Sites whose ranks will be demoted in click-distance calculation.</b:Description>
           <b:DisplayInAdminUI>false</b:DisplayInAdminUI>
           <b:Filter i:nil="true"></b:Filter>
           <b:Id>3</b:Id>
           <b:IsDeleted>false</b:IsDeleted>
           <b:LastCompilationTime>0001-01-01T00:00:00</b:LastCompilationTime>
           <b:LastModifiedBy>username</b:LastModifiedBy>
           <b:LastModifiedTime>2010-01-08T17:53:11.16</b:LastModifiedTime>
           <b:Name>Rank Demoted Sites</b:Name>
           <b:SiteUrl i:nil="true"></b:SiteUrl>
         </b:ScopeInfo>
       </GetScopesForConsumerResult>
     </GetScopesForConsumerResponse>
   </s:Body>
 </s:Envelope>