... | ... | @@ -238,4 +238,57 @@ JSON object identifying a delivery info entry: |
|
|
```
|
|
|
|
|
|
* `dm_id` and `di_id` are data message (**dm**) and delivery info (**di**) identifiers as used in ISDS and in Datovka application (strings containing positive integers).
|
|
|
* `locations` list of all locations where the corresponding message or delivery info is stored. This may be an empty list if the corresponding **dm** or **di** is not stored by the service. |
|
|
\ No newline at end of file |
|
|
* `locations` list of all locations where the corresponding message or delivery info is stored. This may be an empty list if the corresponding **dm** or **di** is not stored by the service.
|
|
|
|
|
|
### Reporting Status of the Data Box (`upload_account_status`)
|
|
|
|
|
|
Reports status of the data box immediately after a successful account synchronisation.
|
|
|
|
|
|
> Support for this operation has been added in Datovka 4.15.0.
|
|
|
|
|
|
```
|
|
|
POST https://document.service.cz/publicapi/v1/upload_account_status
|
|
|
```
|
|
|
|
|
|
JSON request:
|
|
|
```
|
|
|
{
|
|
|
box_id: "data-box identifier as used in ISDS"
|
|
|
user_id: "ISDS username used to access the data box"
|
|
|
time: "UTC date and time in ISO 8601 format"
|
|
|
dm_cnt_rcvd_not_accepted: 0
|
|
|
dm_cnt_snt_not_accepted: 2
|
|
|
dm_cnt_rcvd_not_in_rm: 12
|
|
|
dm_cnt_snt_not_in_rm: 12
|
|
|
}
|
|
|
```
|
|
|
|
|
|
* `box_id` - alphanumeric identifier of the data box
|
|
|
* `user_id` - user identifier (the user name which is used to log into the data box)
|
|
|
* `time` - Indicates the time when the data in this report were collected. The server should not rely on the value as it can be actually invalid (because it is taken from the system which Datovka is running on). The server should decide whether to accept or reject the report based on the difference of the actual time when this report has been received and the time indicated in this value. An error message should be generated if the server decides to reject the report.
|
|
|
* `dm_cnt_rcvd_not_accepted` - number of delivered received messages which have not been accepted. See [dictionary of terms](https://gitlab.labs.nic.cz/datovka/datovka/wikis/term-dictionary).
|
|
|
* `dm_cnt_snt_not_accepted` - number of sent messages which have not been accepted by the recipient
|
|
|
* `dm_cnt_rcvd_not_in_rm` - number of received messages which have not been sent to the records management service
|
|
|
* `dm_cnt_snt_not_in_rm` - number of sent messages which have not been sent to the records management service
|
|
|
|
|
|
JSON response:
|
|
|
```
|
|
|
{
|
|
|
"error": {
|
|
|
"code": "error code",
|
|
|
"description": "explanatory error description"
|
|
|
}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
Proposed values of error `code`:
|
|
|
* `"UNSPECIFIED"` - unspecified internal error; `description` should give a more or less detailed explanation of what has happened.
|
|
|
* `"MALFORMED_REQUEST"` - the JSON request is corrupt.
|
|
|
|
|
|
In cases when no error is reported then the server should return a `null` error:
|
|
|
|
|
|
```
|
|
|
{
|
|
|
"error": null
|
|
|
}
|
|
|
``` |
|
|
\ No newline at end of file |