Class ResultModel
Namespace: Cephalon.AspNetCore.Transports.Rest
Assembly: Cephalon.AspNetCore.dll
Represents the optional Cephalon REST success envelope projected by the ASP.NET Core adapter.
public class ResultModel<TModel>Type Parameters
Section titled “Type Parameters”TModel
The payload type carried by the response.
Inheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”ResultModel()
Section titled “ ResultModel()”Initializes a new instance of the
public ResultModel()Properties
Section titled “Properties”Gets or sets the payload returned by the endpoint.
[JsonPropertyName("data")]public TModel? Data { get; set; }Property Value
Section titled “Property Value”TModel?
Errors
Section titled “ Errors”Gets or sets the structured error details when the response is not successful.
[JsonPropertyName("errors")]public List<ResultModelErrorDetail>? Errors { get; set; }Property Value
Section titled “Property Value”Message
Section titled “ Message”Gets or sets the human-readable response message.
[JsonPropertyName("message")]public string Message { get; set; }Property Value
Section titled “Property Value”StatusCode
Section titled “ StatusCode”Gets or sets the effective HTTP status code associated with the response.
[JsonPropertyName("status")]public int StatusCode { get; set; }Property Value
Section titled “Property Value”Success
Section titled “ Success”Gets or sets a value indicating whether the response is successful.
[JsonPropertyName("success")]public bool Success { get; set; }Property Value
Section titled “Property Value”Gets or sets the short response title.
[JsonPropertyName("title")]public string Title { get; set; }Property Value
Section titled “Property Value”Gets or sets the optional problem type URI associated with the response.
[JsonPropertyName("type")][JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]public string? Type { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Success envelopes omit this value by default. Error envelopes derive the RFC problem type from