Class JsonApiException

Namespace

JsonApiDotNetCore.Errors

Assembly

JsonApiDotNetCore.dll

The base class for an Exception that represents one or more JSON:API error objects in an unsuccessful response.

[PublicAPI]
public class JsonApiException : Exception, ISerializable

Inheritance

object

Exception

JsonApiException

Implements

ISerializable

Derived

CannotClearRequiredRelationshipException

DuplicateLocalIdValueException

FailedOperationException

IncompatibleLocalIdTypeException

InvalidModelStateException

InvalidQueryException

InvalidQueryStringParameterException

InvalidRequestBodyException

LocalIdSingleOperationException

MissingTransactionSupportException

NonParticipatingTransactionException

RelationshipNotFoundException

ResourceAlreadyExistsException

ResourceNotFoundException

ResourcesInRelationshipsNotFoundException

RouteNotAvailableException

UnknownLocalIdValueException

UnsuccessfulActionResultException

Inherited Members

Exception.GetBaseException()

Exception.GetType()

Exception.ToString()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

Exception.SerializeObjectState

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

JsonApiException(ErrorObject, Exception?)

public JsonApiException(ErrorObject error, Exception? innerException = null)

Parameters

error ErrorObject

innerException Exception

JsonApiException(IEnumerable<ErrorObject>, Exception?)

public JsonApiException(IEnumerable<ErrorObject> errors, Exception? innerException = null)

Parameters

errors IEnumerable<ErrorObject>

innerException Exception

Properties

Errors

public IReadOnlyList<ErrorObject> Errors { get; }

Property Value

IReadOnlyList<ErrorObject>

Methods

GetSummary()

public string GetSummary()

Returns

string