taler-docs

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

get-monitoring-reserve-in-inconsistency.rst (1701B)


      1 .. http:get:: /monitoring/reserve-in-inconsistency
      2 
      3   Get a list of reserve in 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:`ReserveInInconsistency` objects.
     20 
     21   **Details:**
     22 
     23   .. ts:def:: ReserveInInconsistency
     24 
     25     interface ReserveInInconsistency {
     26 
     27       // Unique row identifier
     28       row_id : Integer;
     29 
     30       // Amount the exchange expects to be in the reserve
     31       amount_exchange_expected : Amount;
     32 
     33       // Amount deposited into the reserve
     34       amount_wired : Amount;
     35 
     36       // Public key of the reserve
     37       reserve_pub : EddsaPublicKey;
     38 
     39       // Time of the deposit
     40       timestamp : Timestamp;
     41 
     42       // Account associated with the reserve
     43       account : string;
     44 
     45       // Human readable diagnostic of the problem
     46       diagnostic : string;
     47 
     48       // True if this diagnostic was suppressed.
     49       suppressed : boolean;
     50 
     51     }
     52 
     53   .. note::
     54 
     55     This endpoint is still experimental. The endpoint will be further developed as needed.