taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-monitoring-reserve-balance-insufficient-inconsistency.rst (2480B)

      1 .. http:get:: /monitoring/reserve-balance-insufficient-inconsistencies
      2 
      3   Get a list of reserve balance insufficient inconsistencies 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   Pagination follows the :ref:`row-id-pagination` convention.  The non-zero signed
     10   ``limit`` defaults to ``-20``.
     11 
     12   :query limit: Optional non-zero signed number of records; negative values request descending row IDs.
     13   :query offset: Optional :ts:type:`SafeUint64` row ID from which to begin.
     14   :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false.
     15 
     16 
     17   With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
     18 
     19   **Response:**
     20 
     21   :http:statuscode:`200 OK`:
     22     The auditor responds with a :ts:type:`ReserveBalanceInsufficientInconsistencyResponse` object. Its ``records`` field is empty if no matching elements were found.
     23   :http:statuscode:`400 Bad request`:
     24     The request is malformed. Returned with an
     25     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     26   :http:statuscode:`401 Unauthorized`:
     27     The request lacks valid authentication credentials.
     28     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     29   :http:statuscode:`500 Internal Server Error`:
     30     The server experienced an internal error.
     31     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED``,
     32     ``TALER_EC_GENERIC_DB_FETCH_FAILED``, or
     33     ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE`` error code.
     34 
     35 
     36 
     37   **Details:**
     38 
     39   .. ts:def:: ReserveBalanceInsufficientInconsistencyResponse
     40 
     41     interface ReserveBalanceInsufficientInconsistencyResponse {
     42 
     43       records: ReserveBalanceInsufficientInconsistency[];
     44 
     45     }
     46 
     47   .. ts:def:: ReserveBalanceInsufficientInconsistency
     48 
     49     interface ReserveBalanceInsufficientInconsistency {
     50 
     51       // Unique row identifier
     52       row_id : SafeUint64;
     53 
     54       // Public key of the affected reserve
     55       reserve_pub : EddsaPublicKey;
     56 
     57       // Whether this inconsistency is profitable for the exchange
     58       inconsistency_gain : boolean;
     59 
     60       // Amount possibly lost or gained by the exchange
     61       inconsistency_amount : Amount;
     62 
     63       // True if this diagnostic was suppressed.
     64       suppressed : boolean;
     65 
     66     }
     67 
     68   .. note::
     69 
     70     This endpoint is still experimental. The endpoint will be further developed as needed.