diff options
| author | Christian Grothoff <christian@grothoff.org> | 2023-01-06 21:16:18 +0100 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2023-01-06 21:16:18 +0100 |
| commit | c205465852740973eca1055b6381a5cf272170ea (patch) | |
| tree | c1b589bde930f41092158b91d778cc8fc323e9d7 /core/api-wire.rst | |
| parent | 508658030cd1215ad8c81d200ad2ad4c1ded2a56 (diff) | |
| download | docs-c205465852740973eca1055b6381a5cf272170ea.tar.gz docs-c205465852740973eca1055b6381a5cf272170ea.tar.bz2 docs-c205465852740973eca1055b6381a5cf272170ea.zip | |
-formatting and document 204 case
Diffstat (limited to 'core/api-wire.rst')
| -rw-r--r-- | core/api-wire.rst | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/core/api-wire.rst b/core/api-wire.rst index 97021ad8..5ac3a7aa 100644 --- a/core/api-wire.rst +++ b/core/api-wire.rst @@ -161,6 +161,8 @@ Querying the transaction history :http:statuscode:`200 OK`: JSON object of type `IncomingHistory`. + :http:statuscode:`204 No content`: + There are not transactions to report (under the given filter). :http:statuscode:`400 Bad request`: Request malformed. The bank replies with an `ErrorDetail` object. :http:statuscode:`401 Unauthorized`: @@ -267,7 +269,7 @@ Querying the transaction history * A value that is **smaller** than all other row IDs if *delta* is **positive**. * A value that is **larger** than all other row IDs if *delta* is **negative**. - **Request** + **Request:** :query start: *Optional.* Row identifier to explicitly set the *starting point* of the query. @@ -280,12 +282,18 @@ Querying the transaction history the bank may return a response immediately or after waiting only a fraction of ``long_poll_ms``. - **Response** + **Response:** - :http:statuscode:`200 OK`: JSON object of type `OutgoingHistory`. - :http:statuscode:`400 Bad request`: Request malformed. The bank replies with an `ErrorDetail` object. - :http:statuscode:`401 Unauthorized`: Authentication failed, likely the credentials are wrong. - :http:statuscode:`404 Not found`: The endpoint is wrong or the user name is unknown. The bank replies with an `ErrorDetail` object. + :http:statuscode:`200 OK`: + JSON object of type `OutgoingHistory`. + :http:statuscode:`204 No content`: + There are not transactions to report (under the given filter). + :http:statuscode:`400 Bad request`: + Request malformed. The bank replies with an `ErrorDetail` object. + :http:statuscode:`401 Unauthorized`: + Authentication failed, likely the credentials are wrong. + :http:statuscode:`404 Not found`: + The endpoint is wrong or the user name is unknown. The bank replies with an `ErrorDetail` object. .. ts:def:: OutgoingHistory |