taler-docs

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

get-search.rst (673B)

      1 .. http:get:: /search
      2 
      3   Search for user accounts from user query.
      4 
      5   **Request:**
      6 
      7   :query keywords:
      8     Textual search keywords. The fields matched depends on the bank. It can be a name, a login or any other identifier.
      9 
     10   **Response:**
     11 
     12   :http:statuscode:`200 OK`:
     13     Response is a `Accounts`.
     14   :http:statuscode:`204 No content`:
     15     No accounts match this query.
     16 
     17 
     18   **Details:**
     19 
     20   .. ts:def:: Accounts
     21 
     22     interface Accounts {
     23       accounts: Account[];
     24     }
     25 
     26   .. ts:def:: Account
     27 
     28     interface Account {
     29       // Formatted user information to be displayed.
     30       display: string;
     31 
     32       // Full payto URI of this bank account.
     33       payto_uri: string;
     34     }