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.

Inheritance

object

BasicErrorResponse

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.Admin.Leaderboards

Assembly: Unity.Services.Apis.dll

Syntax

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

Constructors

BasicErrorResponse(string, string, int, int, string, string)

Initializes a new instance of the BasicErrorResponse class.

Declaration

[Preserve]
public BasicErrorResponse(string type = null, string title = null, int status = 0, int code = 0, string detail = null, string instance = 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	Service specific error code. Codes include: - 27000: Deletion of the specified leaderboard is in progress at the time of the request - 27001: Score submission required to view the scores of this leaderboard - 27002: Unknown error while retrieving leaderboard player names - 27003: Leaderboard entry creation is already in progress - 27004: Leaderboard entry creation is still in progress - 27005: Leaderboard could not be found - 27006: Leaderboard could not be found - 27007: Leaderboard bucket could not be found - 27008: Leaderboard tier could not be found - 27009: Leaderboard entry could not be found - 27010: Leaderboard version could not be found - 27011: Leaderboard already exists with the provided ID - 27012: Leaderboard does not have buckets - 27013: Leaderboard has buckets - 27014: Leaderboard is not tiered (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 may or may not yield further information if dereferenced..

Properties

Code

Service specific error code. Codes include: - 27000: Deletion of the specified leaderboard is in progress at the time of the request - 27001: Score submission required to view the scores of this leaderboard - 27002: Unknown error while retrieving leaderboard player names - 27003: Leaderboard entry creation is already in progress - 27004: Leaderboard entry creation is still in progress - 27005: Leaderboard could not be found - 27006: Leaderboard could not be found - 27007: Leaderboard bucket could not be found - 27008: Leaderboard tier could not be found - 27009: Leaderboard entry could not be found - 27010: Leaderboard version could not be found - 27011: Leaderboard already exists with the provided ID - 27012: Leaderboard does not have buckets - 27013: Leaderboard has buckets - 27014: Leaderboard is not tiered

Declaration

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

Property Value

Type

Description

int

Service specific error code. Codes include: - 27000: Deletion of the specified leaderboard is in progress at the time of the request - 27001: Score submission required to view the scores of this leaderboard - 27002: Unknown error while retrieving leaderboard player names - 27003: Leaderboard entry creation is already in progress - 27004: Leaderboard entry creation is still in progress - 27005: Leaderboard could not be found - 27006: Leaderboard could not be found - 27007: Leaderboard bucket could not be found - 27008: Leaderboard tier could not be found - 27009: Leaderboard entry could not be found - 27010: Leaderboard version could not be found - 27011: Leaderboard already exists with the provided ID - 27012: Leaderboard does not have buckets - 27013: Leaderboard has buckets - 27014: Leaderboard is not tiered

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.

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