diff options
| author | Christian Grothoff <christian@grothoff.org> | 2023-01-06 21:09:40 +0100 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2023-01-06 21:09:40 +0100 |
| commit | f969875a506f35b7d9bb1d6a97b6510b7fd7d611 (patch) | |
| tree | 1253863ada436722a1e0680ef011757613e4b366 /core/api-wire.rst | |
| parent | 2caa9ec930895ab79b8182a21b70ed15dac4b8b7 (diff) | |
| download | docs-f969875a506f35b7d9bb1d6a97b6510b7fd7d611.tar.gz docs-f969875a506f35b7d9bb1d6a97b6510b7fd7d611.tar.bz2 docs-f969875a506f35b7d9bb1d6a97b6510b7fd7d611.zip | |
-formatting
Diffstat (limited to 'core/api-wire.rst')
| -rw-r--r-- | core/api-wire.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/core/api-wire.rst b/core/api-wire.rst index 34c0a0fc..97021ad8 100644 --- a/core/api-wire.rst +++ b/core/api-wire.rst @@ -144,7 +144,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. @@ -157,12 +157,16 @@ 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 `IncomingHistory`. - :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 `IncomingHistory`. + :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:: IncomingHistory |