get-monitoring-purses.rst (1813B)
1 .. http:get:: /monitoring/purses 2 3 Get a list of purses 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 limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. 10 :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. 11 12 With the default settings, the endpoint returns at most the 20 latest elements. 13 14 **Response:** 15 16 :http:statuscode:`200 OK`: 17 The auditor responds with a top level array of :ts:type:`Purses` objects. If no elements could be found, an empty array is returned 18 :http:statuscode:`400 Bad request`: 19 The request is malformed. Returned with an 20 ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code. 21 :http:statuscode:`401 Unauthorized`: 22 The request lacks valid authentication credentials. 23 The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``. 24 :http:statuscode:`500 Internal Server Error`: 25 The server experienced an internal error. 26 The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or 27 ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code. 28 29 **Details:** 30 31 .. ts:def:: Purses 32 33 interface Purses { 34 35 // Unique row identifier 36 auditor_purses_rowid : Integer; 37 38 // Public key of the purse 39 purse_pub : EddsaPublicKey; 40 41 // Amount currently stored in the purse 42 balance : Amount; 43 44 // Amount the purse is intended for / the maximum amount that can be in the purse 45 target : Amount; 46 47 // When the purse expires 48 expiration_date : Timestamp; 49 50 } 51 52 .. note:: 53 54 This endpoint is still experimental. The endpoint will be further developed as needed.