JsonApiCollectionResponse

data class JsonApiCollectionResponse(val data: List<JsonApiResource>, val meta: Map<String, <Error class: unknown class>> = emptyMap(), val links: JsonApiLinks? = null, val included: List<JsonApiResource> = emptyList(), val jsonapi: JsonApiObject? = null) : JsonApiResponse

A collection JSON:API response.

Constructors

Link copied to clipboard
constructor(data: List<JsonApiResource>, meta: Map<String, <Error class: unknown class>> = emptyMap(), links: JsonApiLinks? = null, included: List<JsonApiResource> = emptyList(), jsonapi: JsonApiObject? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The data of the response.

Link copied to clipboard
open override val included: List<JsonApiResource>

The included resources.

Link copied to clipboard
open override val jsonapi: JsonApiObject? = null

Information about the server's JSON:API implementation.

Link copied to clipboard
open override val links: JsonApiLinks? = null

The top-level links of the response.

Link copied to clipboard
open override val meta: Map<String, <Error class: unknown class>>

The top-level meta of the response.