ResponseTypeAttribute Class

Article
10/28/2015

Use this to specify the entity type returned by an action when the declared return type is HttpResponseMessage or IHttpActionResult. The ResponseType will be read by ApiExplorer when generating ApiDescription.

Namespace: System.Web.Http.Description
Assembly: System.Web.Http (in System.Web.Http.dll)

Inheritance Hierarchy

System.Object
System.Attribute
System.Web.Http.Description.ResponseTypeAttribute

Syntax

[AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = true)]
public sealed class ResponseTypeAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Method, AllowMultiple = true)]
public ref class ResponseTypeAttribute sealed : Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = true)>]
type ResponseTypeAttribute = 
    class
        inherit Attribute
    end

<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple := True)>
Public NotInheritable Class ResponseTypeAttribute
    Inherits Attribute

Constructors

	Name	Description
	ResponseTypeAttribute(Type)	Initializes a new instance of the ResponseTypeAttribute class.

Properties

	Name	Description
	ResponseType	Gets the response type.
	TypeId	(Inherited from Attribute.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Attribute.)
	GetHashCode()	(Inherited from Attribute.)
	GetType()	(Inherited from Object.)
	IsDefaultAttribute()	(Inherited from Attribute.)
	Match(Object)	(Inherited from Attribute.)
	ToString()	(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	(Inherited from Attribute.)
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount(UInt32)	(Inherited from Attribute.)
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	(Inherited from Attribute.)

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.