taler-docs

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

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


      1 .. http:get:: /monitoring/reserve-balance-insufficient-inconsistency
      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   :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   :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.
     12 
     13 
     14   With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
     15 
     16   **Response:**
     17 
     18   :http:statuscode:`200 OK`:
     19     The auditor responds with a top level array of :ts:type:`ReserveBalanceInsufficientInconsistency` objects.
     20   :http:statuscode:`400 Bad request`:
     21     The request is malformed. Returned with an
     22     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     23   :http:statuscode:`401 Unauthorized`:
     24     The request lacks valid authentication credentials.
     25     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     26   :http:statuscode:`500 Internal Server Error`:
     27     The server experienced an internal error.
     28     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or
     29     ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code.
     30 
     31 
     32 
     33   **Details:**
     34 
     35   .. ts:def:: ReserveBalanceInsufficientInconsistency
     36 
     37     interface ReserveBalanceInsufficientInconsistency {
     38 
     39       // Unique row identifier
     40       row_id : Integer;
     41 
     42       // Public key of the affected reserve
     43       reserve_pub : EddsaPublicKey;
     44 
     45       // Whether this inconsistency is profitable for the exchange
     46       inconsistency_gain : boolean;
     47 
     48       // Amount possibly lost or gained by the exchange
     49       inconsistency_amount : Amount;
     50 
     51       // True if this diagnostic was suppressed.
     52       suppressed : boolean;
     53 
     54     }
     55 
     56   .. note::
     57 
     58     This endpoint is still experimental. The endpoint will be further developed as needed.