taler-docs

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

get-monitoring-denomination-pending.rst (2492B)

      1 .. http:get:: /monitoring/denomination-pending
      2 
      3   Get a list of denomination pending 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 
     12   With the default settings, the endpoint returns at most the 20 latest elements.
     13 
     14   **Response:**
     15 
     16   :http:statuscode:`200 OK`:
     17     The auditor responds with a top level array of :ts:type:`DenominationPending` objects. If no elements could be found, an empty array is returned
     18   :http:statuscode:`400 Bad request`:
     19     The request is malformed. Returned with an
     20     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     21   :http:statuscode:`401 Unauthorized`:
     22     The request lacks valid authentication credentials.
     23     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     24   :http:statuscode:`500 Internal Server Error`:
     25     The server experienced an internal error.
     26     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or
     27     ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code.
     28 
     29   **Details:**
     30 
     31   .. ts:def:: DenominationPending
     32 
     33     interface DenominationPending {
     34 
     35       // Unique row identifier
     36       row_id : Integer;
     37 
     38       // Hash of the denomination public key
     39       denom_pub_hash : HashCode;
     40 
     41       // Total value of coins remaining in circulation (excluding
     42       // the value of coins that were recouped, those are always
     43       // just under recoup_loss).
     44       denom_balance : Amount;
     45 
     46       // Total value of coins redeemed that exceeds the amount we
     47       // put into circulation. Basically, this value grows if we
     48       // wanted to reduce denom_balance (because a coin was deposited)
     49       // but we could not because the denom_balance was already zero.
     50       denom_loss : Amount;
     51 
     52       // Total number of coins of this denomination that were
     53       // put into circulation.
     54       num_issued : Integer;
     55 
     56       // Total value of the coins put into circulation.
     57       denom_risk : Amount;
     58 
     59       // Losses the exchange had from this denomination due to coins
     60       // that were recouped (after the denomination was revoked).
     61       recoup_loss : Amount;
     62 
     63     }
     64 
     65   .. note::
     66 
     67     This endpoint is still experimental. The endpoint will be further developed as needed.