taler-docs

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

get-monitoring-coin-inconsistency.rst (2415B)

      1 .. http:get:: /monitoring/coin-inconsistencies
      2 
      3   Get a list of coin 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:`CoinInconsistencyResponse` 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   **Details:**
     36 
     37   .. ts:def:: CoinInconsistencyResponse
     38 
     39     interface CoinInconsistencyResponse {
     40 
     41       records: CoinInconsistency[];
     42 
     43     }
     44 
     45   .. ts:def:: CoinInconsistency
     46 
     47     interface CoinInconsistency {
     48 
     49       // Unique row identifier
     50       row_id : SafeUint64;
     51 
     52       // The operation performed by the exchange
     53       operation : string;
     54 
     55       // Total the exchange calculated
     56       exchange_amount : Amount;
     57 
     58       // Total the auditor calculated
     59       auditor_amount : Amount;
     60 
     61       // Public key of the coin in question
     62       coin_pub : EddsaPublicKey;
     63 
     64       // Whether this arithmetic error was profitable for the exchange
     65       profitable : boolean;
     66 
     67       // True if this diagnostic was suppressed.
     68       suppressed : boolean;
     69 
     70     }
     71 
     72   .. note::
     73 
     74     This endpoint is still experimental. The endpoint will be further developed as needed.