Class ZipErrorResponse

Used to hold error messages and validation errors returned by the Zip API.

Inheritance
Object
ZipErrorResponse
Inherited Members
Namespace: Yort.Zip.InStore
Assembly: Yort.Zip.InStore.dll
Syntax
[Serializable]
public class ZipErrorResponse

Constructors

| Improve this Doc View Source

ZipErrorResponse()

Default constructor.

Declaration
public ZipErrorResponse()

Properties

| Improve this Doc View Source

Detail

Sets or returns an error message specific to this instance of the error (as opposed to Title).

Declaration
public string Detail { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

ErrorCode

Sets or returns a string containing an 'error code' that can be used to programmatically take action on a specific error.

Declaration
public string ErrorCode { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

IsValid

Returns a boolean indicatin whether or not the request was valid.

Declaration
public bool IsValid { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Message

Sets or returns the top level error message associated with the response.

Declaration
public string Message { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

ResponseCode

The HTTP status code returned with the response that contained these errors.

Declaration
public int ResponseCode { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Title

Sets or returns a generic description of the error message.

Declaration
public string Title { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

TraceId

Sets or returns a unique value that can be reported to Zip to assist with locating log entries relating to this request.

Declaration
public string TraceId { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Type

A string containing a uri that defines the specific type of error that occurred.

Declaration
public string Type { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

ValidationErrors

An array of errors, keyed by the name of the property that as an error and with the value being an array of related error messages.

Declaration
[JsonPropertyName("errors")]
public IEnumerable<ZipValidationError> ValidationErrors { get; set; }
Property Value
Type Description
IEnumerable<ZipValidationError>