taler-docs

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

get-monitoring-wire-out-inconsistency.rst (1548B)


      1 .. http:get:: /monitoring/wire-out-inconsistency
      2 
      3   Get a list of wire out 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:`WireOutInconsistency` objects. If no elements could be found, an empty array is returned
     20 
     21 
     22 
     23   **Details:**
     24 
     25   .. ts:def:: WireOutInconsistency
     26 
     27     interface WireOutInconsistency {
     28 
     29       // Unique row identifier
     30       row_id : Integer;
     31 
     32       // Account money was wired to
     33       destination_account : string;
     34 
     35       // How much was suppossed to be wired according to the auditor.
     36       expected : Amount;
     37 
     38       // The amount the exchange claims to have wired.
     39       claimed : Amount;
     40 
     41       // True if this diagnostic was suppressed.
     42       suppressed : boolean;
     43 
     44     }
     45 
     46   .. note::
     47 
     48     This endpoint is still experimental. The endpoint will be further developed as needed.