CreatedAtRoute<TValue> Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http.HttpResults

Assembly:: Microsoft.AspNetCore.Http.Results.dll

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An IResult that on execution will write an object to the response with status code Created (201) and Location header. Targets a registered route.

public sealed class CreatedAtRoute<TValue> : Microsoft.AspNetCore.Http.IResult, Microsoft.AspNetCore.Http.IStatusCodeHttpResult, Microsoft.AspNetCore.Http.IValueHttpResult, Microsoft.AspNetCore.Http.IValueHttpResult<TValue>, Microsoft.AspNetCore.Http.Metadata.IEndpointMetadataProvider

type CreatedAtRoute<'Value> = class
    interface IResult
    interface IEndpointMetadataProvider
    interface IStatusCodeHttpResult
    interface IValueHttpResult
    interface IValueHttpResult<'Value>

Public NotInheritable Class CreatedAtRoute(Of TValue)
Implements IEndpointMetadataProvider, IResult, IStatusCodeHttpResult, IValueHttpResult, IValueHttpResult(Of TValue)

Type Parameters

TValue

The type of object that will be JSON serialized to the response body.

Inheritance: Object
CreatedAtRoute<TValue>

Implements: IResult IStatusCodeHttpResult IValueHttpResult IValueHttpResult<TValue> IEndpointMetadataProvider

Properties

RouteName	Gets the name of the route to use for generating the URL.
RouteValues	Gets the route data to use for generating the URL.
StatusCode	Gets the HTTP status code: Status201Created
Value	Gets the object result.

Methods

ExecuteAsync(HttpContext)

Write an HTTP response reflecting the result.

Explicit Interface Implementations

IEndpointMetadataProvider.PopulateMetadata(MethodInfo, EndpointBuilder)	Populates metadata for the related Endpoint and MethodInfo.
IStatusCodeHttpResult.StatusCode
IValueHttpResult.Value

Applies to