taler-docs

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

get-private-fountains-FOUNTAIN_ID.rst (1062B)

      1 .. http:get:: [/instances/$INSTANCE]/private/fountains/$FOUNTAIN_ID
      2 
      3   Returns detailed information about a specific fountain.
      4   The fountain secret is never returned.
      5   This endpoint is available since protocol **vTokenFountains**.
      6 
      7   **Required permission:** ``fountains-read``
      8 
      9   **Response:**
     10 
     11   :http:statuscode:`200 OK`:
     12     The backend has successfully returned the fountain details.
     13     Returns a `FountainDetails`.
     14   :http:statuscode:`404 Not found`:
     15     The fountain or merchant instance is unknown.
     16     Returned with ``TALER_EC_MERCHANT_GENERIC_FOUNTAIN_UNKNOWN``.
     17   :http:statuscode:`500 Internal Server Error`:
     18     The server experienced an internal failure.
     19 
     20   **Details:**
     21 
     22   .. ts:def:: FountainDetails
     23 
     24     interface FountainDetails {
     25 
     26       // Human-readable description of the fountain.
     27       description: string;
     28 
     29       // How often wallets holding this fountain's secret should
     30       // re-poll ``GET /fountain/info`` for updated grants.
     31       poll_freq: RelativeTime;
     32 
     33       // Grants of this fountain.
     34       grants: FountainGrant[];
     35     }