taler-docs

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

get-monitoring-reserve-balance-summary-wrong-inconsistency.rst (1642B)


      1 .. http:get:: /monitoring/reserve-balance-summary-wrong-inconsistency
      2 
      3   Get a list of reserve balance summary wrong 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   With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
     14 
     15   **Response:**
     16 
     17   :http:statuscode:`200 OK`:
     18     The auditor responds with a top level array of :ts:type:`ReserveBalanceSummaryWrongInconsistency` objects. If no elements could be found, an empty array is returned
     19 
     20   **Details:**
     21 
     22   .. ts:def:: ReserveBalanceSummaryWrongInconsistency
     23 
     24     interface ReserveBalanceSummaryWrongInconsistency {
     25 
     26       // Unique row identifier
     27       row_id : Integer;
     28 
     29       // Public key of the reserve affected
     30       reserve_pub : EddsaPublicKey;
     31 
     32       // Amount of summary the exchange calculated
     33       exchange_amount : Amount;
     34 
     35       // Amount of summary the auditor calculated
     36       auditor_amount : Amount;
     37 
     38       // True if this diagnostic was suppressed.
     39       suppressed : boolean;
     40 
     41     }
     42 
     43   .. note::
     44 
     45     This endpoint is still experimental. The endpoint will be further developed as needed.