taler-docs

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

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

      1 .. http:get:: /monitoring/wire-out-inconsistencies
      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   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:`WireOutInconsistencyResponse` 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 
     36 
     37   **Details:**
     38 
     39   .. ts:def:: WireOutInconsistencyResponse
     40 
     41     interface WireOutInconsistencyResponse {
     42 
     43       records: WireOutInconsistency[];
     44 
     45     }
     46 
     47   .. ts:def:: WireOutInconsistency
     48 
     49     interface WireOutInconsistency {
     50 
     51       // Unique row identifier
     52       row_id : SafeUint64;
     53 
     54       // Account money was wired to
     55       destination_account : string;
     56 
     57       // Row identifier in the exchange's wire-out table.
     58       wire_out_row_id : SafeUint64;
     59 
     60       // Human-readable description of the inconsistency.
     61       diagnostic : string;
     62 
     63       // How much was suppossed to be wired according to the auditor.
     64       expected : Amount;
     65 
     66       // The amount the exchange claims to have wired.
     67       claimed : Amount;
     68 
     69       // True if this diagnostic was suppressed.
     70       suppressed : boolean;
     71 
     72     }
     73 
     74   .. note::
     75 
     76     This endpoint is still experimental. The endpoint will be further developed as needed.