Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ProblemDetails Class

Definition

Namespace:
Microsoft.AspNetCore.Mvc
Assembly:
Microsoft.AspNetCore.Http.Abstractions.dll
Assembly:
Microsoft.AspNetCore.Mvc.Core.dll
Assembly:
Microsoft.AspNetCore.Http.Extensions.dll
Assemblies:
Microsoft.AspNetCore.Http.Abstractions.dll, Microsoft.AspNetCore.Http.Extensions.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.Mvc.Core v2.1.0
Package:
Microsoft.AspNetCore.Mvc.Core v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
ProblemDetails.cs
Source:
ProblemDetails.cs
Source:
ProblemDetails.cs

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.

A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc9110.

public ref class ProblemDetails
public class ProblemDetails
[System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.AspNetCore.Mvc.Infrastructure.ProblemDetailsJsonConverter))]
public class ProblemDetails
[System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.AspNetCore.Http.ProblemDetailsJsonConverter))]
public class ProblemDetails
type ProblemDetails = class
[<System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.AspNetCore.Mvc.Infrastructure.ProblemDetailsJsonConverter))>]
type ProblemDetails = class
[<System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.AspNetCore.Http.ProblemDetailsJsonConverter))>]
type ProblemDetails = class
Public Class ProblemDetails
Inheritance
ProblemDetails
Derived
Attributes

Constructors

Name Description
ProblemDetails()

Properties

Name Description
Detail

A human-readable explanation specific to this occurrence of the problem.
Extensions

Gets the IDictionary<TKey,TValue> for extension members.

Problem type definitions MAY extend the problem details object with additional members. Extension members appear in the same namespace as other members of a problem type.

Instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
Status

The HTTP status code generated by the origin server for this occurrence of the problem; see RFC 9110, Section 15.
Title

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization, e.g. using proactive content negotiation; see RFC 9110, Section 12.
Type

A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type, e.g. using HTML. When this member is not present, its value is assumed to be "about:blank"; see RFC 3986.

Applies to

Feedback

Was this page helpful?