JsonApiError

@Serializable
data class JsonApiError(val id: String? = null, val links: JsonApiError.Links? = null, val status: String? = null, val code: String? = null, val title: String? = null, val detail: String? = null, val source: JsonApiError.Source? = null, val meta: JsonObject? = null)(source)

An error returned by the JSON:API server.

Parameters

id

A unique identifier for this particular occurrence of the problem.

links

A links object. @see JsonApiError.Links

status

The HTTP status code applicable to this problem, expressed as a string value.

code

An application-specific error code, expressed as a string value.

title

A short, human-readable summary of the problem.

detail

A human-readable explanation specific to this occurrence of the problem.

source

An object containing references to the source of the error.

meta

A meta object containing non-standard meta-information about the error. @see JsonApiError.meta

Constructors

Link copied to clipboard
constructor(id: String? = null, links: JsonApiError.Links? = null, status: String? = null, code: String? = null, title: String? = null, detail: String? = null, source: JsonApiError.Source? = null, meta: JsonObject? = null)

Types

Link copied to clipboard
@Serializable
data class Links(val about: String? = null, val type: String? = null)

A links object containing the following members:

Link copied to clipboard
@Serializable
data class Source(val pointer: String? = null, val parameter: String? = null)

An object containing references to the source of the error.

Properties

Link copied to clipboard
val code: String? = null
Link copied to clipboard
val detail: String? = null
Link copied to clipboard
val id: String? = null
Link copied to clipboard
Link copied to clipboard
val meta: JsonObject? = null
Link copied to clipboard
Link copied to clipboard
val status: String? = null
Link copied to clipboard
val title: String? = null