taler-docs

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

get-monitoring-emergency.rst (2725B)

      1 .. http:get:: /monitoring/emergencies
      2 
      3   Get a list of emergencies 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:`EmergencyResponse` 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   **Details:**
     36 
     37   .. ts:def:: EmergencyResponse
     38 
     39     interface EmergencyResponse {
     40 
     41       records: Emergency[];
     42 
     43     }
     44 
     45   .. ts:def:: Emergency
     46 
     47     interface Emergency {
     48 
     49       // Unique row identifier
     50       row_id : SafeUint64;
     51 
     52       // Hash of denomination public key
     53       h_denom_pub : HashCode;
     54 
     55       // What is the total value of all coins of this denomination that
     56       // were put into circulation (and thus the maximum loss the
     57       // exchange may experience due to this emergency).
     58       denom_risk : Amount;
     59 
     60       // What is the loss we have experienced so far (that
     61       // is, the amount deposited in excess of the amount
     62       // we issued).
     63       denom_loss : Amount;
     64 
     65       // When did the exchange start issuing coins in this the denomination.
     66       deposit_start : Timestamp;
     67 
     68       // When does the deposit period end for coins of this denomination.
     69       deposit_end : Timestamp;
     70 
     71       // What is the value of an individual coin of this denomination.
     72       value : Amount;
     73 
     74       // True if this diagnostic was suppressed.
     75       suppressed : boolean;
     76 
     77     }
     78 
     79   .. note::
     80 
     81     This endpoint is still experimental. The endpoint will be further developed as needed.