Class JsonApiDocument

Represents a JSON API Document returned from a JSON API REST endpoint.

Inheritance
object
JsonValue
JsonObject
JsonApiDocument
Implements
Inherited Members
Namespace: Subsembly.Json
Assembly: Subsembly.Json.dll
Syntax
public class JsonApiDocument : JsonObject, ICloneable

Constructors

JsonApiDocument(IJsonApiObjectFactory)

Declaration
public JsonApiDocument(IJsonApiObjectFactory aObjectFactory)
Parameters
Type Name Description
IJsonApiObjectFactory aObjectFactory

Optional object factory that will be used the create the resource objects that may be contained in this document. If this is null, then a plain JsonObject will be used for resource objects.

Properties

DataAsArray

Provides the JSON API document data as a JSON array.

Declaration
public JsonApiResourceObject[] DataAsArray { get; }
Property Value
Type Description
JsonApiResourceObject[]
Remarks

If the actual JSON API document data is a JSON array, then this property provides that array data. If the actual JSON API document data is a single JSON object, then this property returns an array containing that single object. In all other cases an empty array is returned. null.

DataAsObject

If the JSON API document data is represented as single JSON object, then this property provides that object.

Declaration
public JsonApiResourceObject DataAsObject { get; }
Property Value
Type Description
JsonApiResourceObject
Remarks

If the JSON API document data is a JSON array, then this property is null.

DataCount

Returns the number of resource objects provided through the "data" field.

Declaration
public int DataCount { get; }
Property Value
Type Description
int

Errors

Declaration
public JsonApiErrorObjects Errors { get; }
Property Value
Type Description
JsonApiErrorObjects

Included

Declaration
public JsonApiResourceObjects Included { get; }
Property Value
Type Description
JsonApiResourceObjects

JsonApi

Declaration
public JsonApiVersionObject JsonApi { get; }
Property Value
Type Description
JsonApiVersionObject

Meta

Declaration
public JsonObject Meta { get; }
Property Value
Type Description
JsonObject

Version

Provides the JSON API version from the JsonApi object.

Declaration
public string Version { get; }
Property Value
Type Description
string
Remarks

If there is no JsonApi object, then the default "1.0" is returned.

Methods

FindIncluded(string, string)

Declaration
public JsonApiResourceObject FindIncluded(string sType, string sId)
Parameters
Type Name Description
string sType
string sId
Returns
Type Description
JsonApiResourceObject

OnCreateChildArray(string)

Declaration
protected override JsonArray OnCreateChildArray(string sFieldName)
Parameters
Type Name Description
string sFieldName
Returns
Type Description
JsonArray
Overrides

OnCreateChildObject(string)

Declaration
protected override JsonObject OnCreateChildObject(string sFieldName)
Parameters
Type Name Description
string sFieldName
Returns
Type Description
JsonObject
Overrides
Remarks

The default implementation creates a JsonApiResourceObject for the "data" object. An override may create a more specialized type derived from JsonApiResourceObject.

The default implementation creates a plain JsonObject for the "meta" object. An override may create a more spezialized type.

Implements