taler-docs

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

get-donation-statement-YEAR-HASH_DONOR_ID.rst (1359B)

      1 .. http:GET:: /donation-statement/$YEAR/$HASH_DONOR_ID
      2 
      3   Get the donation statement for a specific year and donor.
      4 
      5   **Request:**
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     The request was successful, and the response is a `DonationStatementResponse`.
     11   :http:statuscode:`204 No Content`:
     12     No donation statement exists for the given year and donor.
     13   :http:statuscode:`400 Bad Request`:
     14     The ``$YEAR`` or ``$HASH_DONOR_ID`` in the URL is malformed.
     15     Returned with error code ``TALER_EC_GENERIC_PARAMETER_MALFORMED``.
     16   :http:statuscode:`500 Internal Server Error`:
     17     The Donau encountered an internal error, such as a database failure or
     18     signing key unavailability.
     19     Returned with error code ``TALER_EC_GENERIC_DB_FETCH_FAILED``,
     20     ``TALER_EC_DONAU_GENERIC_KEYS_MISSING``, or
     21     ``TALER_EC_DONAU_SIGNKEY_HELPER_BUG``.
     22   :http:statuscode:`503 Service unavailable`:
     23     The donau is lacking the keys to create the donation statement.
     24     Returned with error code
     25     ``TALER_EC_DONAU_GENERIC_KEYS_MISSING``.
     26 
     27   **Details:**
     28 
     29   .. ts:def:: DonationStatementResponse
     30 
     31     interface DonationStatementResponse {
     32       total: Amount;
     33       // signature over h_donor_tax_id, total, donation_year
     34       donation_statement_sig: EddsaSignature;
     35       // the corresponding public key to the signature
     36       donau_pub: EddsaPublicKey;
     37     }