taler-docs

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

get-private-pots-POT_ID.rst (1060B)

      1 .. http:get:: [/instances/$INSTANCE]/private/pots/$POT_ID
      2 
      3   This is used to obtain detailed information about specific pot.
      4 
      5   **Required permission:** ``pots-read``
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     The backend has successfully returned the detailed information about a specific pot. Returns a `PotDetailResponse`.
     11   :http:statuscode:`400 Bad Request`:
     12     The pot ID parameter is malformed.
     13     Returned with ``TALER_EC_GENERIC_PARAMETER_MALFORMED``.
     14   :http:statuscode:`404 Not found`:
     15     The pot or instance is unknown to the backend.
     16   :http:statuscode:`500 Internal Server Error`:
     17     The server experienced an internal failure.
     18     Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
     19 
     20   **Details:**
     21 
     22   .. ts:def:: PotDetailResponse
     23 
     24     interface PotDetailResponse {
     25 
     26       // Description of the pot. Possibly included
     27       // in the pot message.
     28       description: string;
     29 
     30       // Name of the pot. Must be unique per instance.
     31       pot_name: string;
     32 
     33       // Current total amount in the pot.
     34       pot_totals: Amount[];
     35 
     36     }