taler-docs

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

get-aml-OFFICER_PUB-legitimizations.rst (2255B)

      1 .. http:get:: /aml/$OFFICER_PUB/legitimizations
      2 
      3   Enables AML staff to see which legitimizations are pending
      4   or have been completed.
      5   returns a list of active or finished legitimization
      6   measures (by account).
      7 
      8   This endpoint was introduced in protocol **v23**.
      9 
     10   **Request:**
     11 
     12   *Taler-AML-Officer-Signature*:
     13     The client must provide Base-32 encoded EdDSA signature with
     14     ``$OFFICER_PRIV``, affirming the desire to obtain AML data.  Note that
     15     this is merely a simple authentication mechanism, the details of the
     16     request are not protected by the signature.
     17 
     18   :query limit:
     19     *Optional*. takes value of the form ``N (-N)``, so that at
     20     most ``N`` values strictly older (younger) than ``start`` are returned.
     21     Defaults to ``-20`` to return the last 20 entries (before ``start``).
     22   :query offset:
     23     *Optional*. Row number threshold, see ``limit`` for its
     24     interpretation.  Defaults to ``INT64_MAX``, namely the biggest row id
     25     possible in the database.
     26   :query h_payto:
     27     *Optional*. Account selector using the *normalized* payto URI.
     28     All matching accounts are returned if this
     29     filter is absent, otherwise only decisions for this account.
     30   :query active:
     31     *Optional*. If set to yes, only return active decisions, if no only
     32     decisions that have been superseded. Do not give (or use "all") to
     33     see all decisions regardless of activity status.
     34 
     35   **Response:**
     36 
     37   :http:statuscode:`200 Ok`:
     38     Information about possible measures is returned in a
     39     `LegitimizationMeasuresList` object.
     40 
     41   **Details:**
     42 
     43   .. ts:def:: LegitimizationMeasuresList
     44 
     45     interface LegitimizationMeasuresList {
     46 
     47       // Legitimization measures.
     48       measures: LegitimizationMeasureDetails[];
     49 
     50     }
     51 
     52   .. ts:def:: LegitimizationMeasureDetails
     53 
     54     interface LegitimizationMeasureDetails {
     55 
     56       // Hash of the normalized payto:// URI of the account the
     57       // measure applies to.
     58       h_payto: HashCode;
     59 
     60       // Row of the measure in the exchange database.
     61       rowid: Integer;
     62 
     63       // When was the measure started?
     64       start_time: Timestamp;
     65 
     66       // The the actual measures.
     67       measures: LegitimizationMeasures;
     68 
     69       // Was this measure finished by the customer?
     70       is_finished: boolean;
     71 
     72     }