.NET Framework Class Library
WebInvokeAttribute Class

Represents an attribute indicating that a service operation is logically an invoke operation and that it can be called by the WCF REST programming model.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ServiceModel.WebWebInvokeAttribute

Namespace:   System.ServiceModel.Web
Assembly:  System.ServiceModel.Web (in System.ServiceModel.Web.dll)
Syntax
<[%$TOPIC/bb515593_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/bb515593_en-us_VS_110_2_0_0_0_1%].Method)> _
Public NotInheritable Class WebInvokeAttribute _
	Inherits [%$TOPIC/bb515593_en-us_VS_110_2_0_0_0_2%] _
	Implements [%$TOPIC/bb515593_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/bb515593_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/bb515593_en-us_VS_110_2_0_1_0_1%].Method)]
public sealed class WebInvokeAttribute : [%$TOPIC/bb515593_en-us_VS_110_2_0_1_0_2%], 
	[%$TOPIC/bb515593_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/bb515593_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/bb515593_en-us_VS_110_2_0_2_0_1%]::Method)]
public ref class WebInvokeAttribute sealed : public [%$TOPIC/bb515593_en-us_VS_110_2_0_2_0_2%], 
	[%$TOPIC/bb515593_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/bb515593_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/bb515593_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/bb515593_en-us_VS_110_2_0_3_0_2%].Method)>]
type WebInvokeAttribute =  
    class 
        inherit [%$TOPIC/bb515593_en-us_VS_110_2_0_3_0_3%] 
        interface [%$TOPIC/bb515593_en-us_VS_110_2_0_3_0_4%] 
    end

The WebInvokeAttribute type exposes the following members.

Constructors
  NameDescription
Public method WebInvokeAttributeInitializes a new instance of the WebGetAttribute class.
Top
Properties
  NameDescription
Public property BodyStyleGets and sets the body style of the messages that are sent to and from the service operation.
Public property IsBodyStyleSetExplicitlyGets the IsBodyStyleSetExplicitly property.
Public property IsRequestFormatSetExplicitlyGets the IsRequestFormatSetExplicitly property.
Public property IsResponseFormatSetExplicitlyGets the IsResponseFormatSetExplicitly property.
Public property MethodGets and sets the protocol (for example HTTP) method the service operation responds to.
Public property RequestFormatGets and sets the RequestFormat property.
Public property ResponseFormatGets and sets the ResponseFormat property.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public property UriTemplateThe Uniform Resource Identifier (URI) template for the service operation.
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Explicit interface implemetation Private method IOperationBehaviorAddBindingParametersImplements the AddBindingParameters(OperationDescription, BindingParameterCollection) method.
Explicit interface implemetation Private method IOperationBehaviorApplyClientBehaviorImplements the ApplyClientBehavior(OperationDescription, ClientOperation) method.
Explicit interface implemetation Private method IOperationBehaviorApplyDispatchBehaviorImplements the ApplyDispatchBehavior(OperationDescription, DispatchOperation) method.
Explicit interface implemetation Private method IOperationBehaviorValidateImplements the Validate(OperationDescription) method.
Top
Remarks

The WebInvokeAttribute attribute is applied to a service operation in addition to the OperationContractAttribute and associates the operation with a UriTemplate as well as an underlying transport verb that represents an invocation (for example, HTTP POST, PUT, or DELETE). The WebInvokeAttribute attribute is a passive operation behavior (the IOperationBehavior methods do nothing) that adds metadata to the operation description. Applying the WebInvokeAttribute attribute to a service operation has no effect unless a behavior that looks for this metadata in the operation description (such as WebHttpBehavior) is added to the service's behavior collection. The WebInvokeAttribute determines what HTTP method that a service operation responds to. By default, all methods that have the WebInvokeAttribute applied respond to POST requests. The Method property allows you to specify a different HTTP method. If you want a service operation to respond to GET, use the WebGetAttribute instead.

Examples

The following example shows how to use the WebInvokeAttribute attribute.

NoteNote

Because the Method property is not specified in the following code, all service operations are mapped to the HTTP POST method.

<ServiceContract()> _
Public Interface ICalculator2
    <OperationContract()> _
    <WebInvoke()> _
    Function Add(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebInvoke(UriTemplate:="Sub?x={x}&y={y}")> _
    Function Subtract(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebInvoke(UriTemplate:="Mult?x={x}&y={y}", BodyStyle:=WebMessageBodyStyle.Bare)> _
    Function Multiply(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebInvoke(UriTemplate:="Div?x={x}&y={y}", BodyStyle:=WebMessageBodyStyle.Bare, RequestFormat:=WebMessageFormat.Xml, ResponseFormat:=WebMessageFormat.Xml)> _
    Function Divide(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
   <WebInvoke(Method:="POST", UriTemplate:="Mod?x={x}&y={y}")> _
   Function Modulo(ByVal x As Long, ByVal y As Long) As Long 
End Interface
[ServiceContract]
public interface ICalculator2
{
    [OperationContract]
    [WebInvoke]
    long Add(long x, long y);

    [OperationContract]
    [WebInvoke(UriTemplate = "Sub?x={x}&y={y}")]
    long Subtract(long x, long y);

    [OperationContract]
    [WebInvoke(UriTemplate = "Mult?x={x}&y={y}", BodyStyle = WebMessageBodyStyle.Bare)]
    long Multiply(long x, long y);

    [OperationContract]
    [WebInvoke(UriTemplate = "Div?x={x}&y={y}", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Xml, ResponseFormat=WebMessageFormat.Xml)]
    long Divide(long x, long y);

    [OperationContract]
    [WebInvoke(Method = "POST", UriTemplate = "Mod?x={x}&y={y}")]
    long Mod(long x, long y);
}
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.