.NET Framework Class Library
WebGetAttribute Class

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

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ServiceModel.WebWebGetAttribute

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

The WebGetAttribute type exposes the following members.

Constructors
  NameDescription
Public method WebGetAttributeInitializes 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 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 UriTemplateGets and sets the 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 WebGetAttribute attribute is applied to a service operation in addition to the OperationContractAttribute and associates the operation with a UriTemplate as well as the HTTP protocol Get verb. The association with HTTP Get verb means that the operation is used to retrieve information from the service. The WebGetAttribute attribute is a passive operation behavior (the IOperationBehavior methods do nothing) that adds metadata to the operation description. Applying the WebGetAttribute attribute to a service operation has no effect unless a behavior that is looking for this metadata in the operation description (such as WebHttpBehavior) is added to the service's behavior collection.

Service operations with the WebGetAttribute attribute applied should be logical retrieval operations. The HTTP GET method is associated with all operations marked with the WebGetAttribute attribute.

Examples

The following example shows how to use the WebGetAttribute attribute.

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

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

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

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

    <OperationContract()> _
    <WebGet(ResponseFormat:=WebMessageFormat.Json)> _
    Function Modulo(ByVal x As Long, ByVal y As Long) As Long 
End Interface
[ServiceContract]
public interface ICalculator
{
    [OperationContract]
    [WebGet]
    long Add(long x, long y);

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

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

    [OperationContract]
    [WebGet(UriTemplate = "Div?x={x}&y={y}", RequestFormat = WebMessageFormat.Xml)]
    long Divide(long x, long y);

    [OperationContract]
    [WebGet(ResponseFormat= WebMessageFormat.Json)]
    long Mod(long x, long y);
}
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 3.5 SP1
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.