Share via

3.1.4.7.2.1 ProviderUpdate

  • Article

This element is the actual content of the protocol server’s RegistrationSoapOut SOAP message. It contains all registration information about a protocol server.

The structure of this element assumes that one protocol server can have multiple search applications, and each search application can have multiple Office SharePoint Server Search services. However, this version of the Search Protocol only supports exactly one search application per protocol server, and exactly one Office SharePoint Server Search service per search application.

 <s:element name="ProviderUpdate">
   <s:complexType>
     <s:sequence>
       <s:element name="Status" type="r:StatusType"/>
       <s:element name="DebugErrorMessage" type="s:string" minOccurs="0"/>
       <s:element name="Providers" minOccurs="0">
         <s:complexType>
           <s:sequence>
             <s:element name="Provider">
               <s:complexType>
                 <s:sequence>
                   <s:element name="Id" type="t:GUIDType"/>
                   <s:element name="Name" type="t:String255"/>
                   <s:element name="QueryPath" type="s:anyURI"/>
                   <s:element name="Type" type="rrs:ProviderType"/>
                   <s:element name="Services" minOccurs="0">
                     <s:complexType>
                       <s:sequence>
                         <s:element name="Service">
                           <s:complexType>
                             <s:sequence>
                               <s:element name="Id" type="t:GUIDType"/>
                               <s:element name="Name" type="t:String255"/>
                               <s:element name="Category" type="t:CategoryType"/>
                               <s:element name="Description" type="t:String2048" minOccurs="0"/>
                               <s:element name="Copyright" type="t:String2048" minOccurs="0"/>
                               <s:element name="Display" type="rrs:DisplayType" minOccurs="0"/>
                             </s:sequence>
                           </s:complexType>
                         </s:element>
                       </s:sequence>
                     </s:complexType>
                   </s:element>
                 </s:sequence>
               </s:complexType>
             </s:element>
           </s:sequence>
         </s:complexType>
       </s:element>
     </s:sequence>
   </s:complexType>
 </s:element>

Status: Status of the request. For possible values, see section 2.2.5.5.

DebugErrorMessage: Contains an error message if an error occurred. If an error occurred, this element MUST contain an empty string or an error message. If no error occurred, this element MUST NOT be present.

Providers: Contains detailed information about the search application that this protocol server offers. Although the name of this element is plural, there MUST be exactly one search application per protocol server. This element MUST only be present if the Status element contains the value "SUCCESS". It MUST NOT be present in any other case.

Providers.Provider: Contains detailed information about a search application.

Providers.Provider.Id: GUID of the search application. This GUID MUST uniquely identify the search application.

Providers.Provider.Name: Name for the search application. This name is intended to be shown in the user interface of the protocol client. The length of this name, as specified in section 2.2.5.8, SHOULD be less than 80 characters to enable easy viewing on the protocol client application.

Providers.Provider.QueryPath: URL to which all query requests to send.

Providers.Provider.Type: Type of the search application, as specified in section 3.1.4.7.4.3, MUST be set to "SOAP".

Providers.Provider.Services: Contains information about the Office SharePoint Server Search service that this search application offers. Although the name of this element is plural, there MUST be exactly one Office SharePoint Server Search service per search application.

Providers.Provider.Services.Service: Contains information about an Office SharePoint Server Search service.

Providers.Provider.Services.Service.Id: GUID of the Office SharePoint Server Search service. This GUID uniquely identifies the Office SharePoint Server Search service.

Providers.Provider.Services.Service.Name: A name in String255 Simple Type format (as specified in section 2.2.5.8) for the Office SharePoint Server Search service.

Providers.Provider.Services.Service.Category: Category of the Office SharePoint Server Search service, as specified in section 3.1.4.7.4.1. The category given is intended to be shown in the user interface of the protocol client. MUST be set to "INTRANET_GENERAL".

Providers.Provider.Services.Service.Description: Description of the Office SharePoint Server Search service, as specified in section 2.2.5.7.

Providers.Provider.Services.Service.Copyright: Copyright information about the Office SharePoint Server Search service, as specified in section 2.2.5.7. This information is intended to be shown to an administrator only.

Providers.Provider.Services.Service.Display: Display state of the Office SharePoint Server Search service, as specified in section 3.1.4.7.4.2, MUST be set to "On".