Research Services Schemas Overview

  • Article

The Research Service Software Development Kit defines schemas for registration requests and responses, queries, and responses to queries. The following is an outline of these schemas.

Registration schemas

  • The registration request schema, specified by the urn:Microsoft.Search.Registration.Request namespace, defines a registration request to a research service provider.
  • The registration response schema, specified by the urn:Microsoft.Search.Registration.Response namespace, defines a registration response from a research service provider.
  • The discovery schema, specified by the http://schemas.microsoft.com/Office/Research/2002/8/Discovery namespace, defines the response that a discovery service uses to return a list of services to be advertised or automatically installed.

Query schemas

  • The query schema, specified by the urn:Microsoft.Search.Query namespace, defines a query packet which can contain other queries that correspond to each of the provider's services.
  • The query context schema, specified by the urn:Microsoft.Search.Query.Office.Context namespace, defines context information augmenting a query. The root element in this schema is designed to be used inside the Microsoft.Search.Query.xsd schema.
  • The query keywords schema, specified by the urn:Microsoft.Search.Query.Office.Keywords namespace, defines a list of keywords representing a query. The root element in this schema is designed to be used inside the Microsoft.Search.Query.xsd schema.
  • The service parameters schema, specified by the urn:Microsoft.Search.Office.ServiceParameters namespace, defines form information augmenting a query. The root element in this schema is designed to be used inside the Microsoft.Search.Query.xsd schema.

Response schemas

  • The response schema, specified by the urn:Microsoft.Search.Response namespace, defines a response packet from a research service provider, which can in turn contain other responses, corresponding to each of the provider's research services.
  • The response content schema, specified by the urn:Microsoft.Search.Response.Content namespace, defines rich content and actions that can be returned as part of a response packet. The root element is used within the Microsoft.Search.Response.xsd schema.
  • The response document schema, specified by the urn:Microsoft.Search.Response.Document namespace, defines a document type that can be returned as part of a response packet. The document type may contain a title, description, or URL. The root element is used within the Microsoft.Search.Response.xsd schema.
  • The response form schema, specified by the urn:Microsoft.Search.Response.Form namespace, defines a form that can be returned as part of a response packet. The response form schema describes all the form elements and their relationships. A form enables a research service to interact with the user. A form is submitted when the user clicks a form element having the @action="requery" attribute. At this point, a query containing the form's data is generated to requery only the same research service. The Research task pane is then updated with search results from that service.

Types schema

urn:Microsoft.Search.Typesurn:Microsoft.Search