Share via

Microsoft.Search.Response Schema Documentation

  • Article

This topic contains documentation for the Microsoft.Search.Response schema. For the schema itself, see Microsoft.Search.Response Schema.

Documentation for the urn:Microsoft.Search.Response schema

Defines a response packet from a service provider, which can in turn contain several individual responses corresponding to each of the provider's services.

Basic Schema Attributes

Attribute Value
targetNamespace urn:Microsoft.Search.Response
elementFormDefault qualified
attributeFormDefault unqualified (default)

Declared Namespaces

Namespace Prefix
urn:Microsoft.Search.Types t:
urn:Microsoft.Search.Response (default)
http://www.w3.org/2001/XMLSchema xsd:
http://www.w3.org/XML/1998/namespace xml:

Imported Schemas

namespace id schemaLocation
urn:Microsoft.Search.Types (none) Microsoft.Search.Types.xsd
urn:Microsoft.Search.Response.Document (none) Microsoft.Search.Response.Document.xsd
urn:Microsoft.Search.Response.Form (none) Microsoft.Search.Response.Form.xsd
urn:Microsoft.Search.Response.Content (none) Microsoft.Search.Response.Content.xsd

Overview

<ResponsePacket>

            <Response>

                        <QueryId/>

                        <Copyright/>

                        <OriginatorContext>

                                    <Any/>

                        </OriginatorContext>

                        <RequeryContext>

                                    <Any/>

                        </RequeryContext>

                        <Range>

                                    <ResultType/>

                                    <StartAt/>

                                    <Count/>

                                    <MustDisplayCount/>

                                    <TotalAvailable/>

                                    <Results>

                                                <Any/>

                                    </Results>

                                    <Any/>

                        </Range>

                        <Status/>

                        <DebugErrorMessage/>

                        <Any/>

            </Response>

            <Any/>

</ResponsePacket>

Top-Level Elements

Element: ResponsePacket

A response from a service provider to a query. The response may contain several individual responses corresponding to the services offered by the provider.

Property Value
abstract false (default)
name ResponsePacket
nillable false (default)
type complexType

Attributes

  • Attribute: revision

    Unsigned integer indicating the revision of the schema used in the response.

    Property Value
    name revision
    type xsd:unsignedInt
    use optional

  • Attribute: build

    The build of the component used to generate the response.

    Property Value
    name build
    type t:String255
    use optional

  • Attribute: providerRevision

    Current revision of the provider. If the revision is different from the one the client has stored, Microsoft® Office 2003 will prompt the user to update the service.

    Property Value
    name providerRevision
    type xsd:unsignedInt
    use optional

Subelements: Sequence

Elements must appear in the specified order.

  • Element: Response

    An individual response from a service to a query.

    Property Value
    abstract false (default)
    minOccurs 1
    maxOccurs unbounded
    name Response
    nillable false (default)
    type ResponseType

  • Any

    Any element in another namespace. Can be used for extensibility in the future.

    Property Value
    namespace ##other
    processContents skip
    minOccurs 0
    maxOccurs unbounded

Top-Level Types and Groups

  • Complex Type: ResponseType

    Defines an individual response from a service to a query.

    Attributes

    • Attribute: domain

      A unique domain identifier for the service handling the query. The value should match the domain of one of the query elements in the QueryPacket corresponding to this ResponsePacket.

      Property Value
      name domain
      type t:String255
      use optional

    Subelements: Sequence

    Elements must appear in the specified order.

    • Element: QueryId

      Unique string that identifies the query for tracking purposes. Office always uses a globally unique identifier (GUID).

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs 1 (default)
      name QueryId
      nillable false (default)
      type t:String255

    • Element: Copyright

      The result can contain a copyright notice if the provider is concerned about misuse of the results. This is not displayed to the user in Office 2003.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs 1 (default)
      name Copyright
      nillable false (default)
      type xsd:string

    • Element: OriginatorContext

      Client data that is being round-tripped through the service. The data is passed by the client to the server inside the QueryPacket\Query\Context\OriginatorContext element.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs 1 (default)
      name OriginatorContext
      nillable false (default)
      type OriginatorContextType

    • Element: RequeryContext

      Service data being round-tripped through the client.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs 1 (default)
      name RequeryContext
      nillable false (default)
      type RequeryContextType

    • Element: Range

      The same number of ranges are returned as were queried for, no more, no less. Office will never request more than one range.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs unbounded
      name Range
      nillable false (default)
      type RangeType

    • Element: Status

      Status of the query. It indicates whether the query was successful.

      Property Value
      abstract false (default)
      minOccurs 1
      maxOccurs 1 (default)
      name Status
      nillable false (default)
      type StatusType

    • Element: DebugErrorMessage

      If Status != SUCCESS, the error message in English is returned here for debugging purposes. This is not displayed to the user in Office.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs 1 (default)
      name DebugErrorMessage
      nillable false (default)
      type t:String2048

    • Any

      Any element in another namespace. Can be used for extensibility in the future.

      Property Value
      namespace ##other
      processContents skip
      minOccurs 0
      maxOccurs unbounded

  • Complex Type: OriginatorContextType

    Defines context data from the client to be round-tripped through the service.

    Attributes

    None

    Subelements: Sequence

    Elements must appear in the specified order.

    • Any

      Any element in another namespace. This is an XML island the client passed to the service for round-tripping.

      Property Value
      namespace ##other
      processContents skip
      minOccurs 1 (default)
      maxOccurs unbounded

  • Complex Type: RequeryContextType

    Defines the requery context that a service can have the client pass back, during a requery only. It is an arbitrary XML data island.

    Attributes

    None

    Subelements: Sequence

    Elements must appear in the specified order.

    • Any

      Any element in another namespace. This is an XML island the service is passing to the client for round-tripping.

      Property Value
      namespace ##other
      processContents skip
      minOccurs 1 (default)
      maxOccurs unbounded

  • Complex Type: RangeType

    Defines the Range element containing the results and information about them.

    Attributes

    • Attribute: id

      A unique ID for the Range element.

      Property Value
      name id
      type xsd:string
      use optional

    Subelements: Sequence

    Elements must appear in the specified order.

    • Element: ResultType

      Optional string describing the type of result. Office will not use the value of this element.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs unbounded
      name ResultType
      nillable false (default)
      type t:String2048

    • Element: StartAt

      The index of the initial result, based on "1" as the lowest result index.

      Property Value
      abstract false (default)
      default 1
      minOccurs 0
      maxOccurs 1 (default)
      name StartAt
      nillable false (default)
      type t:StartAtType

    • Element: Count

      Total results of this type to return. Note that fewer than this number may be returned if there are not enough results, and more than this number may be returned due to policy restrictions. If more results are returned, the client should display them all. Absence of Count implies provider discretion.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs 1 (default)
      name Count
      nillable false (default)
      type xsd:unsignedInt

    • Element: MustDisplayCount

      Minimum number of results that should be displayed.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs 1 (default)
      name MustDisplayCount
      nillable false (default)
      type xsd:unsignedInt

    • Element: TotalAvailable

      The total number available. This number may not be 100% accurate and all these results may not be accessible.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs 1 (default)
      name TotalAvailable
      nillable false (default)
      type xsd:unsignedInt

    • Element: Results

      Results can come back in all formats that are specified as supported and the results are returned in the server's preferred order to display. This element is nonexistent if no results are returned.

      Property Value
      abstract false (default)
      minOccurs 0
      maxOccurs 1 (default)
      name Results
      nillable false (default)
      type ResultCollectionType

    • Any

      Any element in another namespace. Can be used for extensibility in the future.

      Property Value
      namespace ##other
      processContents skip
      minOccurs 0
      maxOccurs unbounded

  • Complex Type: ResultCollectionType

    Defines a set of results, in any format supported.

    Attributes

    None

    Subelements: Choice

    Only one element can be chosen.

    The maximum number of occurrences (maxOccurs) for the choice is unbounded.

    • Any

      Any element in another namespace. Elements here will be in any results format supported by the client. Office will support the Form, Document, and Content results types.

      Property Value
      namespace ##other
      processContents strict (default)
      minOccurs 1 (default)
      minOccurs 1 (default)

  • simpleType: StatusType

    Defines the status of the search.

    Base

    base xsd:string

    Restrictions

    Restriction Value
    enumeration

    SUCCESS

    ERROR

    ERROR_SERVER_TRANSIENT

    ERROR_SERVER

    ERROR_NO_RESPONSE

    ERROR_BAD_RESULTS

    ERROR_NO_RESULTS_FOUND

    ERROR_OUT_OF_ORDER

    ERROR_NO_CONNECTION

    ERROR_NO_AUTHENTICATION

    ERROR_NO_AUTHORIZATION