Module

FPO.Dto.DocumentDto.DocumentTree

This module defines the DocumentTree type, which represents the hierarchical structure of a document.

#DocumentTreeTE​

type DocumentTreeTE = DocumentTree NodeHeader

A DocumentTree with NodeHeader (alias TextElement) nodes, as given by the GET /docs/{documentID}/tree/{treeRevision} endpoint.

#DocumentTreeTER​

type DocumentTreeTER = DocumentTree TextElementRevision

A DocumentTree with TextElementRevision nodes, as given by the POST docs endpoint.

#DocumentTree​

type DocumentTree a = RootTree a

#decodeDocument​

decodeDocument :: forall a. DecodeJson a => Json -> Either JsonDecodeError (DocumentTree a)

#encodeDocumentTree​

encodeDocumentTree :: DocumentTree NodeHeader -> Json

Encodes a DocumentTree NodeHeader as a DocumentTree TextElementID.

Modules