ProblemDetails Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc
Assembly:
Microsoft.AspNetCore.Mvc.Core.dll
Assembly:
Microsoft.AspNetCore.Http.Extensions.dll
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.0

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

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
Object
ProblemDetails
Derived
Attributes
JsonConverterAttribute

Constructors

ProblemDetails()

Properties

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([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
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[RFC7231], Section 3.4).
Type

A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".

Applies to