ApiController Class

Article
10/28/2015

Defines properties and methods for API controller.

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

Inheritance Hierarchy

System.Object
System.Web.Http.ApiController

Syntax

public abstract class ApiController : IHttpController, IDisposable

public ref class ApiController abstract : IHttpController, IDisposable

[<AbstractClass>]
type ApiController = 
    class
        interface IHttpController
        interface IDisposable
    end

Public MustInherit Class ApiController
    Implements IHttpController, IDisposable

Constructors

	Name	Description
	ApiController()

Properties

	Name	Description
	ActionContext	Gets the action context.
	Configuration	Gets the HttpConfiguration of the current ApiController.
	ControllerContext	Gets the HttpConfiguration of the current ApiController.
	ModelState	Gets the model state after the model binding process.
	Request	Gets or sets the HttpRequestMessage of the current ApiController.
	RequestContext	Gets the request context.
	Url	Gets an instance of a UrlHelper, which is used to generate URLs to other APIs.
	User	Returns the current principal associated with this request.

Methods

	Name	Description
	BadRequest()	Creates a BadRequestResult.
	BadRequest(ModelStateDictionary)	Creates an InvalidModelStateResult with the specified model state.
	BadRequest(String)	Creates an T:System.Web.Http.Results.ErrorMessageResult (400 Bad Request) with the specified error message.
	Conflict()	Creates a ConflictResult (409 Conflict).
	Content<T>(HttpStatusCode, T)	Creates a <see cref="T:System.Web.Http.NegotiatedContentResult`1" /> with the specified values.
	Content<T>(HttpStatusCode, T, MediaTypeFormatter)	Creates a <see cref="T:System.Web.Http.FormattedContentResult`1" /> with the specified values.
	Content<T>(HttpStatusCode, T, MediaTypeFormatter, MediaTypeHeaderValue)	Creates a <see cref="T:System.Web.Http.FormattedContentResult`1" /> with the specified values.
	Content<T>(HttpStatusCode, T, MediaTypeFormatter, String)	Creates a <see cref="T:System.Web.Http.FormattedContentResult`1" /> with the specified values.
	Created<T>(String, T)	Creates a CreatedNegotiatedContentResult<T> (201 Created) with the specified values.
	Created<T>(Uri, T)	Creates a CreatedNegotiatedContentResult<T> (201 Created) with the specified values.
	CreatedAtRoute<T>(String, IDictionary<String, Object>, T)	Creates a CreatedAtRouteNegotiatedContentResult<T> (201 Created) with the specified values.
	CreatedAtRoute<T>(String, Object, T)	Creates a CreatedAtRouteNegotiatedContentResult<T> (201 Created) with the specified values.
	Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Dispose(Boolean)	Releases the unmanaged resources that are used by the object and, optionally, releases the managed resources.
	Equals(Object)	(Inherited from Object.)
	ExecuteAsync(HttpControllerContext, CancellationToken)	Executes asynchronously a single HTTP operation.
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	Initialize(HttpControllerContext)	Initializes the ApiController instance with the specified controllerContext.
	InternalServerError()	Creates an InternalServerErrorResult (500 Internal Server Error).
	InternalServerError(Exception)	Creates an ExceptionResult (500 Internal Server Error) with the specified exception.
	Json<T>(T)	Creates a JsonResult<T> (200 OK) with the specified value.
	Json<T>(T, JsonSerializerSettings)	Creates a JsonResult<T> (200 OK) with the specified values.
	Json<T>(T, JsonSerializerSettings, Encoding)	Creates a JsonResult<T> (200 OK) with the specified values.
	MemberwiseClone()	(Inherited from Object.)
	NotFound()	Creates a NotFoundResult.
	Ok()	Creates an OkResult (200 OK).
	Ok<T>(T)	Creates an OkNegotiatedContentResult<T> with the specified values.
	Redirect(String)	Creates a redirect result (302 Found) with the specified value.
	Redirect(Uri)	Creates a redirect result (302 Found) with the specified value.
	RedirectToRoute(String, IDictionary<String, Object>)	Creates a redirect to route result (302 Found) with the specified values.
	RedirectToRoute(String, Object)	Creates a redirect to route result (302 Found) with the specified values.
	ResponseMessage(HttpResponseMessage)	Creates a ResponseMessageResult with the specified response.
	StatusCode(HttpStatusCode)	Creates a T:System.Web.Http.StatusCodeResult with the specified status code.
	ToString()	(Inherited from Object.)
	Unauthorized(AuthenticationHeaderValue[])	Creates an UnauthorizedResult (401 Unauthorized) with the specified values.
	Unauthorized(IEnumerable<AuthenticationHeaderValue>)	Creates an UnauthorizedResult (401 Unauthorized) with the specified values.
	Validate<TEntity>(TEntity)	Validates the given entity and adds the validation errors to the model state under the empty prefix, if any.
	Validate<TEntity>(TEntity, String)	Validates the given entity and adds the validation errors to the model state, if any.

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.