taler-docs

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

get-monitoring-denominations-without-sigs.rst (1632B)


      1 .. http:get:: /monitoring/denominations-without-sigs
      2 
      3   Get a list of denominations without signatures 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 
     14   With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
     15 
     16   **Response:**
     17 
     18   :http:statuscode:`200 OK`:
     19     The auditor responds with a top level array of :ts:type:`DenominationsWithoutSigs` objects.
     20 
     21 
     22 
     23   **Details:**
     24 
     25   .. ts:def:: DenominationsWithoutSigs
     26 
     27     interface DenominationsWithoutSigs {
     28 
     29       // Unique row identifier
     30       row_id : Integer;
     31 
     32       // Hash of the denomination public key
     33       denompub_h : HashCode;
     34 
     35       // Value of each coin of the denomination that lacks
     36       // the auditor's signature.
     37       value : Amount;
     38 
     39       // From when the denomination key in question is valid
     40       start_time : Timestamp;
     41 
     42       // When the denomination key in question expires
     43       end_time : Timestamp;
     44 
     45       // True if this diagnostic was suppressed.
     46       suppressed : boolean;
     47 
     48     }
     49 
     50   .. note::
     51 
     52     This endpoint is still experimental. The endpoint will be further developed as needed.