commit a9179b7e2bc87311afb04879749621541204cb12 parent af11ed5ff33defdb3b01e14b2c2be146848a8abc Author: MS <ms@taler.net> Date: Thu, 9 Feb 2023 17:47:30 +0100 circtuit API filter on the accounts list. Diffstat:
| M | libeufin/api-sandbox.rst | | | 17 | ++++++++++++++++- |
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst @@ -194,11 +194,17 @@ Accounts .. http:get:: /accounts - Obtains a list of all the accounts registered at the bank. + Obtains a list of the accounts registered at the bank. It returns only the information that this API handles, without any balance or transactions list. The :doc:`Access API </core/api-bank-access>` offers that. This request is only available to the administrator. + **Request:** + + :query filter: *Optional.* + Regual expression to filter on the account username. Without + this option, **all** the existing accounts are returned. + **Response:** `CircuitAccounts <circuit-accounts_>`_ @@ -222,6 +228,15 @@ Accounts } + :http:statuscode:`200 OK`: + At least one account was found. + + :http:statuscode:`204 No Content`: + No accounts were found for the given request. + + :http:statuscode:`403 Forbidden`: + A ordinary user invoked this call. + .. http:get:: /accounts/$username Obtains information relative to the account owned by