Class ProblemDetails

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

Inheritance

Object

ProblemDetails

ValidationProblemDetails

Inherited Members

Object.Equals(Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: IRM.Extensions.Http

Assembly: IRM.Extensions.Http.dll

Syntax

public class ProblemDetails

Properties

Detail

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

Declaration

public string Detail { get; set; }

Property Value

String

Extensions

Gets the System.Collections.Generic.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.

Declaration

public IDictionary<string, object> Extensions { get; }

Property Value

System.Collections.Generic.IDictionary<String, Object>

Remarks

The round-tripping behavior for Extensions is determined by the implementation of the Input \ Output formatters. In particular, complex types or collection types may not round-trip to the original type when using the built-in JSON or XML formatters.

Instance

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

Declaration

public string Instance { get; set; }

Property Value

String

Status

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

Declaration

public int? Status { get; set; }

Property Value

System.Nullable<System.Int32>

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).

Declaration

public string Title { get; set; }

Property Value

String

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".

Declaration

public string Type { get; set; }

Property Value

String