get-monitoring-balances.rst (1247B)
1 .. http:get:: /monitoring/balances 2 3 Get a list of balances stored by the auditor. 4 5 The following query parameters are optional, and can be used to customise the response: 6 7 **Request:** 8 9 :query balance_key: a string identifying a balance. If specified, only returns the balance with this exact key. The default value is NULL. 10 11 **Response:** 12 13 :http:statuscode:`200 OK`: 14 The auditor responds with a top level array of :ts:type:`Balances` objects. If no elements could be found, an empty array is returned 15 :http:statuscode:`400 Bad request`: 16 The request is malformed. Returned with an 17 ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code. 18 :http:statuscode:`401 Unauthorized`: 19 The request lacks valid authentication credentials. 20 The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``. 21 :http:statuscode:`500 Internal Server Error`: 22 The server experienced an internal error. 23 The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or 24 ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code. 25 26 **Details:** 27 28 .. ts:def:: Balances 29 30 interface Balances { 31 32 // String identifying a balance 33 balance_key : string; 34 35 // Amount of the balance 36 balance_value : Amount; 37 38 }