taler-docs

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

get-charities.rst (1096B)

      1 .. http:GET::  /charities
      2 
      3   GET all charities. Only allowed if the request comes with the administration bearer token.
      4 
      5   return all charities
      6 
      7   **Request:**
      8 
      9   **Reponse:**
     10 
     11   :http:statuscode:`200 OK`:
     12     The request was successful, and the response is a `Charities`.
     13 
     14   **Details:**
     15 
     16   .. ts:def:: Charities
     17 
     18     interface Charities{
     19       charities: CharitySummary[];
     20     }
     21 
     22   .. ts:def:: CharitySummary
     23 
     24     interface CharitySummary {
     25 
     26       // Unique ID of the charity within the Donau.
     27       charity_id: Integer;
     28 
     29       // Public key of the charity, used by the charity to
     30       // authorize issuing donation receipts.
     31       charity_pub: EddsaPublicKey;
     32 
     33       // Human-readable name of the charity.
     34       charity_name: string;
     35 
     36       // Maximum amount of donation receipts this charity is
     37       // allowed to issue per year.
     38       max_per_year: Amount;
     39 
     40       // Year for which ``receipts_to_date`` is given.
     41       current_year: Integer;
     42 
     43       // Total amount of donation receipts the donau has
     44       // issued for this charity so far this year.
     45       receipts_to_date: Amount;
     46     }