taler-docs

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

get-conversion-rate-classes.rst (1287B)

      1 .. http:get:: /conversion-rate-classes
      2 
      3   Returns the list of all conversion rate classes.
      4 
      5   Only available to the administrator.
      6 
      7   Since protocol **v9**.
      8 
      9   **Request:**
     10 
     11   :query limit: *Optional.*
     12     At most return the given number of results. Negative for descending by ``conversion_rate_class_id``, positive for ascending by ``conversion_rate_class_id``. Defaults to ``-20``.
     13   :query offset: *Optional.*
     14     Starting ``conversion_rate_class_id`` for :ref:`pagination <row-id-pagination>`.
     15   :query filter_name: *Optional.*
     16     Pattern to filter on the class name.  Given
     17     the filter 'foo', all the classes will **contain**
     18     'foo' in their name.  Without this option,
     19     all the existing classes are returned.
     20 
     21   **Response:**
     22 
     23   :http:statuscode:`200 OK`:
     24     Response is a `ConversionRateClasses`.
     25   :http:statuscode:`401 Unauthorized`:
     26     Invalid or missing credentials.
     27   :http:statuscode:`403 Forbidden`:
     28     Missing rights.
     29   :http:statuscode:`404 Not Found`:
     30     The conversion rate class was not found.
     31   :http:statuscode:`501 Not implemented`:
     32     This server does not support conversion, client should check config response.
     33 
     34   **Details:**
     35 
     36   .. ts:def:: ConversionRateClasses
     37 
     38     interface ConversionRateClasses {
     39       classes: ConversionRateClass[];
     40     }