taler-docs

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

get-private-fountains.rst (914B)

      1 .. http:get:: [/instances/$INSTANCE]/private/fountains
      2 
      3   Lists all fountains of the instance.
      4   This endpoint is available since protocol **vTokenFountains**.
      5 
      6   **Required permission:** ``fountains-read``
      7 
      8   **Response:**
      9 
     10   :http:statuscode:`200 OK`:
     11     The backend has successfully returned the list of fountains.
     12     Returns a `FountainsListResponse`.
     13   :http:statuscode:`404 Not found`:
     14     The merchant instance is unknown.
     15   :http:statuscode:`500 Internal Server Error`:
     16     The server experienced an internal failure.
     17 
     18   **Details:**
     19 
     20   .. ts:def:: FountainsListResponse
     21 
     22     interface FountainsListResponse {
     23 
     24       // All fountains of this instance.
     25       fountains: FountainEntry[];
     26     }
     27 
     28   .. ts:def:: FountainEntry
     29 
     30     interface FountainEntry {
     31 
     32       // Identifier of the fountain.
     33       fountain_id: string;
     34 
     35       // Human-readable description of the fountain.
     36       description: string;
     37     }