... | ... | @@ -55,6 +55,8 @@ The response must consist of a hierarchy of following JSON objects: |
|
|
"name": "name of the client or document",
|
|
|
"id": "location identifier",
|
|
|
"metadata": ["some", "additional", "information"],
|
|
|
"case_id": ["P/2018", "R Q 2017"],
|
|
|
"court_case_id": ["A/B"],
|
|
|
"sub": [{...}, {...}, ...]
|
|
|
}
|
|
|
```
|
... | ... | @@ -64,6 +66,8 @@ Each such JSON object identifies a node and contains the following information: |
|
|
* `name` is the name of the node in the hierarchy. May be `null ` if it is the root node and the name of the root should not be displayed/used. When displaying the hierarchy in the client application the value of `name` must be used for filtering or searching.
|
|
|
* `id` is a unique string identifier of the place in the hierarchy. The obtained value may be `null` in cases when there is no possibility to upload a file into this location. Empty strings must not be used as `id`. The value of `id` must be used to identify the place where a (ZFO) file (message or delivery info) should be uploaded when using the **upload_file** service.
|
|
|
* `metadata` contains an array of strings according to which the location can be searched or filtered on the client site. The array may be empty if no such data are provided. If array is non-empty, then values in the list must be used as additional data for filtering and searching in the hierarchy in the client application.
|
|
|
* `case_id` is an optional entry. *It is recognised by Datovka starting from version 4.13.0.* It contains a list of strings. The list may be empty or it must contain only non-empty strings. All entries within this list must be unique - no string is allowed to be repeated in this list. Every string represents a single document identifier (Czech: jednací číslo nebo spisová značka) as used by the **user of the records management service**.
|
|
|
* `court_case_id` - is an optional entry. *It is recognised by Datovka starting from version 4.13.0.* It contains a list of strings. The list may be empty or it must contain only non-empty strings. All entries within this list must be unique - no string is allowed to be repeated in this list. Every string represents a single document identifier (Czech: jednací číslo nebo spisová značka) as used by the **opposite party**.
|
|
|
* `sub` contains an array of subordinate nodes (described by similar JSON objects). The array is empty if the node is a leaf.
|
|
|
|
|
|
**Note:** There is no purpose of sending leaf nodes (i.e. with empty list in `sub`) that have `id` equal to `null` in the response JSON document. Such nodes don't have any sub-nodes nor there is any possibility to upload files into such nodes.
|
... | ... | |