Class ErrorResponseBody

ErrorResponseBody

Inheritance

object

ErrorResponseBody

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.QoS

Assembly: Unity.Services.Apis.dll

Syntax

[DataContract(Name = "ErrorResponseBody")]
[Preserve]
public class ErrorResponseBody

Constructors

ErrorResponseBody(string, string, int, int, string, string, List<object>)

Initializes a new instance of the ErrorResponseBody class.

Declaration

[Preserve]
public ErrorResponseBody(string type = null, string title = null, int status = 0, int code = 0, string detail = null, string instance = null, List<object> details = null)

Parameters

Type	Name	Description
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". (required).
string	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). (required).
int	status	The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. (required).
int	code	A service-specific error code. (required).
string	detail	A human-readable explanation specific to this occurrence of the problem. (required).
string	instance	A URI reference that identifies the specific occurrence of the problem. It might or might not yield further information if dereferenced..
List<object>	details	An array of machine-readable service-specific errors..

Properties

Code

A service-specific error code.

Declaration

[DataMember(Name = "code", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public int Code { get; set; }

Property Value

Type	Description
int	A service-specific error code.

Detail

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

Declaration

[DataMember(Name = "detail", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string Detail { get; set; }

Property Value

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

Details

An array of machine-readable service-specific errors.

Declaration

[DataMember(Name = "details", EmitDefaultValue = false)]
[Preserve]
public List<object> Details { get; set; }

Property Value

Type	Description
List<object>	An array of machine-readable service-specific errors.

Instance

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

Declaration

[DataMember(Name = "instance", EmitDefaultValue = false)]
[Preserve]
public string Instance { get; set; }

Property Value

Type	Description
string	A URI reference that identifies the specific occurrence of the problem. It might or might 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.

Declaration

[DataMember(Name = "status", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public int Status { get; set; }

Property Value

Type	Description
int	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).

Declaration

[DataMember(Name = "title", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string Title { get; set; }

Property Value

Type	Description
string	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".

Declaration

[DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string Type { get; set; }

Property Value

Type	Description
string	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".