WebGetAttribute Class (System.ServiceModel.Web)

.NET Framework Class Library

WebGetAttribute Class

Updated: November 2007

Indicates that a service operation is logically a retrieval operation and that it can be called by the Web programming model.

Namespace: System.ServiceModel.Web
Assembly: System.ServiceModel.Web (in System.ServiceModel.Web.dll)

Syntax

Visual Basic (Declaration)

<AttributeUsageAttribute(AttributeTargets.Method)> _
Public NotInheritable Class WebGetAttribute _
    Inherits Attribute _
    Implements IOperationBehavior, IWmiInstanceProvider

Visual Basic (Usage)

Dim instance As WebGetAttribute

[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class WebGetAttribute : Attribute, 
    IOperationBehavior, IWmiInstanceProvider

Visual C++

[AttributeUsageAttribute(AttributeTargets::Method)]
public ref class WebGetAttribute sealed : public Attribute, 
    IOperationBehavior, IWmiInstanceProvider

/** @attribute AttributeUsageAttribute(AttributeTargets.Method) */
public final class WebGetAttribute extends Attribute implements IOperationBehavior, 
    IWmiInstanceProvider

JScript

public final class WebGetAttribute extends Attribute implements IOperationBehavior, IWmiInstanceProvider

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.

Visual Basic

<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);
}

Inheritance Hierarchy

System..::.Object
System..::.Attribute
System.ServiceModel.Web..::.WebGetAttribute

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.

Platforms

Windows Vista, Windows XP SP2, Windows Server 2003

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

Version Information

.NET Framework

Supported in: 3.5

Reference

WebGetAttribute Members

System.ServiceModel.Web Namespace

Product Families

Resources

About Microsoft

Popular Places

Popular Searches

Popular Downloads

.NET Framework

Reference