Class BasicErrorResponse
Referenced from - https://tools.ietf.org/html/rfc7807#page-3 Consumers MUST use the "type" string as the primary identifier for the problem type; the 'title' string is advisory and included only for users who are not aware of the semantics of the URI and do not have the ability to discover them (e.g., offline log analysis). Consumers SHOULD NOT automatically dereference the type URI. The "status" member, if present, is only advisory; it conveys the HTTP status code used for the convenience of the consumer. Generators MUST use the same status code in the actual HTTP response, to assure that generic HTTP software that does not understand this format still behaves correctly. See Section 5 for further caveats regarding its use. Consumers can use the status member to determine what the original status code used by the generator was, in cases where it has been changed (e.g., by an intermediary or cache), and when message bodies persist without HTTP information. Generic HTTP software will still use the HTTP status code. The "detail" member, if present, ought to focus on helping the client correct the problem, rather than giving debugging information.
Inherited Members
Namespace: Unity.Services.Apis.Admin.CloudSave
Assembly: Unity.Services.Apis.dll
Syntax
[DataContract(Name = "BasicErrorResponse")]
[Preserve]
public class BasicErrorResponse
Constructors
BasicErrorResponse(string, string, int, int, string, string, List<object>)
Initializes a new instance of the Basic
Declaration
[Preserve]
public BasicErrorResponse(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).. |
int | status | The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.. |
int | code | Service specific error code. |
string | detail | A human-readable explanation specific to this occurrence of the problem.. |
string | instance | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.. |
List<object> | details | Machine readable service specific errors.. |
Properties
Code
Service specific error code
Declaration
[DataMember(Name = "code", EmitDefaultValue = false)]
[Preserve]
public int Code { get; set; }
Property Value
Type | Description |
---|---|
int | Service specific error code |
Detail
A human-readable explanation specific to this occurrence of the problem.
Declaration
[DataMember(Name = "detail", EmitDefaultValue = false)]
[Preserve]
public string Detail { get; set; }
Property Value
Type | Description |
---|---|
string | A human-readable explanation specific to this occurrence of the problem. |
Details
Machine readable service specific errors.
Declaration
[DataMember(Name = "details", EmitDefaultValue = false)]
[Preserve]
public List<object> Details { get; set; }
Property Value
Instance
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
Declaration
[DataMember(Name = "instance", EmitDefaultValue = true)]
[Preserve]
public string Instance { get; set; }
Property Value
Type | Description |
---|---|
string | 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.
Declaration
[DataMember(Name = "status", EmitDefaultValue = false)]
[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", EmitDefaultValue = false)]
[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". |