Class Document

Namespace

JsonApiDotNetCore.Serialization.Objects

Assembly

JsonApiDotNetCore.dll

See https://jsonapi.org/format#document-top-level and https://jsonapi.org/ext/atomic/#document-structure.

[PublicAPI]
public sealed class Document

Inheritance

object

Document

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Data

[JsonPropertyName("data")]
public SingleOrManyData<ResourceObject> Data { get; set; }

Property Value

SingleOrManyData<ResourceObject>

Errors

[JsonPropertyName("errors")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IList<ErrorObject>? Errors { get; set; }

Property Value

IList<ErrorObject>

Included

[JsonPropertyName("included")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IList<ResourceObject>? Included { get; set; }

Property Value

IList<ResourceObject>

JsonApi

[JsonPropertyName("jsonapi")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public JsonApiObject? JsonApi { get; set; }

Property Value

JsonApiObject

Links

[JsonPropertyName("links")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public TopLevelLinks? Links { get; set; }

Property Value

TopLevelLinks

Meta

[JsonPropertyName("meta")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IDictionary<string, object?>? Meta { get; set; }

Property Value

IDictionary<string, object>

Operations

[JsonPropertyName("atomic:operations")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IList<AtomicOperationObject?>? Operations { get; set; }

Property Value

IList<AtomicOperationObject>

Results

[JsonPropertyName("atomic:results")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IList<AtomicResultObject>? Results { get; set; }

Property Value

IList<AtomicResultObject>