# Microsoft.Search.Registration.Response Schema Documentation

This topic contains documentation for the Microsoft.Search.Registration.Response schema. For the text of the schema, see Microsoft.Search.Registration.Response Schema.

## Documentation for the urn:Microsoft.Search.Registration.Response schema

Defines a registration response from a service provider.

## Basic Schema Attributes

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

## Declared Namespaces

Namespace | Prefix
--- | ---
urn:Microsoft.Search.Types | t:
urn:Microsoft.Search.Registration.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

## Overview

<ProviderUpdate>

<Status/>

<Message/>

<Providers>

<Provider>

<Message/>

<License>

<LicenseText/>

<Any/>

</License>

<Id/>

<Name/>

<QueryPath/>

<RegistrationPath/>

<AboutPath/>

<Type/>

<Revision/>

<Services>

<Service>

<Id/>

<Name/>

<Data/>

<Description/>

<AboutPath/>

<Copyright/>

<TermsOfUsePath/>

<Display/>

<Category/>

<OptionsPath/>

<Parental/>

<Any/>

</Service>

<Any/>

</Services>

<Any/>

</Provider>

<Any/>

</Providers>

<Any/>

</ProviderUpdate>

## Top-Level Elements

Element: ProviderUpdate

Contains all registration information about a service provider.

Property | Value
--- | ---
abstract | false (default)
name | ProviderUpdate
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

Subelements: Sequence

Elements must appear in the specified order.

- Element: Status

  Status of the response.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 1
  maxOccurs | 1 (default)
  name | Status
  nillable | false (default)
  type | ResultsCodeType

- Element: Message

  Message to display to the user before the registration process begins.

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

- Element: Providers

  Data for all providers being registered.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 0
  maxOccurs | 1 (default)
  name | Providers
  nillable | false (default)
  type | ProviderCollectionType

- 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: ProviderCollectionType

  Attributes

  - Attribute: revision

    Revision of the provider collection. Not currently used, as only one provider is expected in the collection.

    Property | Value
    --- | ---
    default | 0
    name | revision
    type | xsd:unsignedInt
    use | optional

  Subelements: Sequence

  Elements must appear in the specified order.

  - Element: Provider

    The registration information for a single service provider.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | Provider
    nillable | false (default)
    type | ProviderInfoType

  - 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: ProviderInfoType

  Defines the registration information for a single service provider.

  Attributes

  - Attribute: action

    Optional attribute added for extensibility. It is not currently used.

    Property | Value
    --- | ---
    name | action
    type | t:String255
    use | optional

  Subelements: Sequence

  Elements must appear in the specified order.

  - Element: Message

    A welcome message in the registration process.

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

  - Element: License

    The text of a license to be presented to the user during registration.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 0
    maxOccurs | 1 (default)
    name | License
    nillable | false (default)
    type | LicenseType

  - Element: Id

    Unique provider ID.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | Id
    nillable | false (default)
    type | t:GUIDType

  - Element: Name

    Provider name that will appear in the user interface.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | Name
    nillable | false (default)
    type | t:String255

  - Element: QueryPath

    Path to which all queries will be sent. Normally it should be a URL.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | QueryPath
    nillable | false (default)
    type | xsd:anyURI

  - Element: RegistrationPath

    The path where service updates can be found. Normally it should be a URL.

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

  - Element: AboutPath

    The path where more information about the provider can be found. Normally it should be a URL.

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

  - Element: Type

    Type of provider. SOAP is the expected value.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | Type
    nillable | false (default)
    type | ProviderType

  - Element: Revision

    Provider revision. Microsoft® Office 2003 will save this value and then compare it against the ResponsePacket's providerRevision attribute in future query responses. If providerRevision is different than the stored value, Office will prompt the user to update the provider's information.

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

  - Element: Services

    Collection of services provided by the provider.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 0
    maxOccurs | 1 (default)
    name | Services
    nillable | false (default)
    type | ServiceCollectionType

  - 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: LicenseType

  Defines the text of a license to be presented to the user during registration.

  Attributes

  - Attribute: acceptRequired

    If set to true, require that the user accept the license before continuing.

    Property | Value
    --- | ---
    name | acceptRequired
    type | xsd:boolean
    use | required

  Subelements: Sequence

  Elements must appear in the specified order.

  - Element: LicenseText

    Text of a license to be presented to the user during registration.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | LicenseText
    nillable | false (default)
    type | xsd:string

  - 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: ServiceCollectionType

  Contains the registration information for each service offered by a provider.

  Attributes

  None

  Subelements: Sequence

  Elements must appear in the specified order.

  - Element: Service

    Information for an individual service.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | unbounded
    name | Service
    nillable | false (default)
    type | ServiceInfoType

  - 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: ServiceInfoType

  Defines the information for an individual service.

  Attributes

  None

  Subelements: Sequence

  Elements must appear in the specified order.

  - Element: Id

    Unique provider ID.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | Id
    nillable | false (default)
    type | t:GUIDType

  - Element: Name

    Service name.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | Name
    nillable | false (default)
    type | t:String255

  - Element: Data

    Service data that will be stored and sent up with every query.

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

  - Element: Description

    Service description that will display in the service's property page.

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

  - Element: AboutPath

    Path to more information about the service. Typically, it should be a URL.

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

  - Element: Copyright

    Copyright that will display in the service's property page.

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

  - Element: TermsOfUsePath

    Path to a full terms of use page. Typically, it should be a URL.

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

  - Element: Display

    Display state of the service. It defines how the service appears in the user interface.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 0
    maxOccurs | 1 (default)
    name | Display
    nillable | false (default)
    type | DisplayType

  - Element: Category

    Defines the category under which the service appears in the user interface.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | Category
    nillable | false (default)
    type | t:CategoryType

  - Element: OptionsPath

    Path to an options page for the service. Normally it should be a URL.

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

  - Element: Parental

    Indicates whether the service supports filtering of potentially offensive content.

    Property | Value
    --- | ---
    abstract | false (default)
    default | Unsupported
    minOccurs | 0
    maxOccurs | 1 (default)
    name | Parental
    nillable | false (default)
    type | ParentalType

  - Any

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

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

- simpleType: ResultsCodeType

  Defines the possible result codes.

  Base

  base | xsd:string

  Restrictions

  Restriction | Value
  --- | ---
  enumeration | SUCCESS ERROR ERROR_NOT_COMPATIBLE

- simpleType: ProviderType

  There are two types of providers: internal providers that ship with Office and external providers that are accessed through SOAP.

  Base

  base | xsd:string

  Restrictions

  Restriction | Value
  --- | ---
  enumeration | SOAP Internal

- simpleType: DisplayType

  Defines the visibility of the service in the user interface. Hidden services are typically translation services that do not explicitly appear in the user interface.

  Base

  base | xsd:string

  Restrictions

  Restriction | Value
  --- | ---
  enumeration | On Off Hidden

- simpleType: ParentalType

  Indicates whether a service supports filtering of potentially offensive content.

  Base

  base | xsd:string

  Restrictions

  Restriction | Value
  --- | ---
  enumeration | Supported Unsupported

©2003-2004 Microsoft Corporation. All rights reserved. Permission to copy, display and distribute this document is available at: http://msdn.microsoft.com/library/en-us/odcXMLRef/html/odcXMLRefLegalNotice.asp