Class ErrorStatus
The body that will be returned for any failing request. We are using the RFC 7807 Error Format.
Inherited Members
Namespace: Unity.Services.Apis.Lobbies
Assembly: Unity.Services.Apis.dll
Syntax
[DataContract(Name = "ErrorStatus")]
[Preserve]
public class ErrorStatus
Constructors
ErrorStatus(string, int, string, string, int, List<Detail>)
Initializes a new instance of the Error
Declaration
[Preserve]
public ErrorStatus(string type = null, int status = 0, string title = null, string detail = null, int code = 0, List<Detail> details = null)
Parameters
Type | Name | Description |
---|---|---|
string | type | A URI that identifies the problem type and should provide documentation for the problem.. |
int | status | The HTTP status code of the response.. |
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.. |
string | detail | A human-readable explanation specific to this occurrence of the problem.. |
int | code | An integer in the range 16000-16999 that uniquely identifies an error type. This can be used to programatically identify the type of error.. |
List<Detail> | details | A list of additional details about specific errors.. |
Properties
Code
An integer in the range 16000-16999 that uniquely identifies an error type. This can be used to programatically identify the type of error.
Declaration
[DataMember(Name = "code", EmitDefaultValue = false)]
[Preserve]
public int Code { get; set; }
Property Value
Type | Description |
---|---|
int | An integer in the range 16000-16999 that uniquely identifies an error type. This can be used to programatically identify the type of error. |
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
A list of additional details about specific errors.
Declaration
[DataMember(Name = "details", EmitDefaultValue = false)]
[Preserve]
public List<Detail> Details { get; set; }
Property Value
Status
The HTTP status code of the response.
Declaration
[DataMember(Name = "status", EmitDefaultValue = false)]
[Preserve]
public int Status { get; set; }
Property Value
Type | Description |
---|---|
int | The HTTP status code of the response. |
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.
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. |
Type
A URI that identifies the problem type and should provide documentation for the problem.
Declaration
[DataMember(Name = "type", EmitDefaultValue = false)]
[Preserve]
public string Type { get; set; }
Property Value
Type | Description |
---|---|
string | A URI that identifies the problem type and should provide documentation for the problem. |