taler-docs

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

get-monitoring-purse-not-closed-inconsistencies.rst (2354B)

      1 .. http:get:: /monitoring/purse-not-closed-inconsistencies
      2 
      3   Get a list of purse 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   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   With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
     17 
     18   **Response:**
     19 
     20   :http:statuscode:`200 OK`:
     21     The auditor responds with a :ts:type:`PurseNotClosedInconsistenciesResponse` object. Its ``records`` field is empty if no matching elements were found.
     22   :http:statuscode:`400 Bad request`:
     23     The request is malformed. Returned with an
     24     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     25   :http:statuscode:`401 Unauthorized`:
     26     The request lacks valid authentication credentials.
     27     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     28   :http:statuscode:`500 Internal Server Error`:
     29     The server experienced an internal error.
     30     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED``,
     31     ``TALER_EC_GENERIC_DB_FETCH_FAILED``, or
     32     ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE`` error code.
     33 
     34 
     35 
     36   **Details:**
     37 
     38   .. ts:def:: PurseNotClosedInconsistenciesResponse
     39 
     40     interface PurseNotClosedInconsistenciesResponse {
     41 
     42       records: PurseNotClosedInconsistencies[];
     43 
     44     }
     45 
     46   .. ts:def:: PurseNotClosedInconsistencies
     47 
     48     interface PurseNotClosedInconsistencies {
     49 
     50       // Unique row identifier.
     51       row_id : SafeUint64;
     52 
     53       // Public key of the affected purse
     54       purse_pub : EddsaPublicKey;
     55 
     56       // Amount still in the purse, which should have been refunded
     57       amount : Amount;
     58 
     59       // When the purse expired
     60       expiration_date : Timestamp;
     61 
     62       // True if this diagnostic was suppressed.
     63       suppressed : boolean;
     64 
     65     }
     66 
     67   .. note::
     68 
     69     This endpoint is still experimental. The endpoint will be further developed as needed.