Web Services Settings Schema

  • Article

This topic is specific to a legacy technology. XML Web services and XML Web service clients should now be created using Windows Communication Foundation.

The Web services settings schema defines configuration file elements that control the behavior of ASP.NET Web services and their clients. The parent element is <webServices>.

By default, the <webServices> element and its descendants are applied to any Web service or proxy class to which the configuration applies. The configuration is applied according to the application type, as follows:

  • ASP.NET Web application (service or client): Refer to ASP.NET Configuration File Hierarchy and Inheritance concerning the standard rules for configuration inheritance, scoping, and precedence within an ASP.NET Web application. The <webServices> element typically is placed in a Web.config file.

  • Stand-alone .NET Framework application (client only): Refer to Application Configuration Files. The <webServices> element typically is placed in the application configuration file.

The <webServices> element and its descendants are applied to the following kinds of classes:

A <webServices> element can be applied to both a Web service and a client where a Web application contains both entities.

<configuration>
   <system.web>
      <webServices>
         <protocols>
            <add>
            <remove>
            <clear>
         <serviceDescriptionFormatExtensionTypes>
            <add>
            <remove>
            <clear>
         <soapExtensionTypes>
            <add>
            <remove>
            <clear>
         <soapExtensionImporterTypes>
            <add>
            <remove>
            <clear>
         <soapExtensionReflectorTypes>
            <add>
            <remove>
            <clear>
         <wsdlHelpGenerator>

Element Description

<add> for <protocols>

Adds a specified protocol that an ASP.NET Web service can use to receive request data sent from a client and to return response data.

<add> for <serviceDescriptionFormatExtensionTypes>

Adds a specified service description format extension (SDFE) class that defines how to extend the service descriptions (WSDL documents) generated for Web services.

<add> for <soapExtensionTypes>

Adds a specified SOAP extension class that provides extended processing of SOAP messages on the Web service or client.

<add> for <soapExtensionImporterTypes>

Adds a specified SOAP extension importer class, which extends the client proxy generation process for use with a service description format extension (SDFE).

<add> for <soapExtensionReflectorTypes>

Adds a specified SOAP extension reflector class, which extends the service description (WSDL document) generation process for use with a service description format extension (SDFE).

<clear>

Removes all references to items appropriate to the parent tag.

<protocols>

Specifies the protocols that an ASP.NET Web service can use to receive request data sent from a client and return response data. A protocol can be used to associate request data with a method and its parameters and to associate response data with the method and its return value.

<remove> for <protocols>

Removes a specified protocol for handling request and response data from within the scope of the configuration file.

<remove> for <serviceDescriptionFormatExtensionTypes>

Removes a specified service description format extension (SDFE) class from within the scope of the configuration file.

<remove> for <soapExtensionTypes>

Removes a specified SOAP extension class from within the scope of the configuration file.

<remove> for <soapExtensionImporterTypes>

Removes a specified SOAP extension importer class from within the scope of the configuration file.

<remove> for <soapExtensionReflectorTypes>

Removes a specified SOAP extension reflector class from within the scope of the configuration file.

<serviceDescriptionFormatExtensionTypes>

Specifies the service description format extension (SDFE) classes used to extend the WSDL documents generated for Web services. SDFE classes provide a means of describing SOAP extensions.

<soapExtensionImporterTypes>

Specifies SOAP extension importer classes, which extend the client proxy generation process. For use with service description format extensions (SDFEs).

<soapExtensionReflectorTypes>

Specifies SOAP extension reflector classes, which extend the service description (WSDL document) generation process. For use with service description format extensions (SDFEs).

<soapExtensionTypes>

Specifies the SOAP extensions used to inspect or modify the SOAP message during processing on the Web service or client. SOAP extensions augment the functionality of Web services.

<webServices>

Controls the settings of Web services deployed using ASP.NET and of Web service clients running on the .NET Framework.

<wsdlHelpGenerator>

Specifies the Web service Help page (an .aspx file) that is displayed to a browser when the browser navigates directly to an ASMX Web services page.

See Also

Other Resources

ASP.NET Settings Schema
XML Web Services Created Using ASP.NET and XML Web Service Clients