taler-docs

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

get-monitoring-reserve-not-closed-inconsistency.rst (2126B)

      1 .. http:get:: /monitoring/reserve-not-closed-inconsistency
      2 
      3   Get a list of reserve not closed 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:`ReserveNotClosedInconsistency` objects.
     19   :http:statuscode:`400 Bad request`:
     20     The request is malformed. Returned with an
     21     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     22   :http:statuscode:`401 Unauthorized`:
     23     The request lacks valid authentication credentials.
     24     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     25   :http:statuscode:`500 Internal Server Error`:
     26     The server experienced an internal error.
     27     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or
     28     ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code.
     29 
     30 
     31 
     32   **Details:**
     33 
     34   .. ts:def:: ReserveNotClosedInconsistency
     35 
     36     interface ReserveNotClosedInconsistency {
     37 
     38       // Unique row identifier
     39       row_id : Integer;
     40 
     41       // Public key of the reserve
     42       reserve_pub : EddsaPublicKey;
     43 
     44       // Amount still in the reserve at the time of expiration
     45       balance : Amount;
     46 
     47       // Date the reserve expired
     48       expiration_time : Timestamp;
     49 
     50       // Human readable string describing the problem
     51       diagnostic : string;
     52 
     53       // True if this diagnostic was suppressed.
     54       suppressed : boolean;
     55 
     56     }
     57 
     58   .. note::
     59 
     60     This endpoint is still experimental. The endpoint will be further developed as needed.