taler-docs

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

get-monitoring-progress.rst (1365B)

      1 .. http:get:: /monitoring/progress
      2 
      3   Get the progress stored by the auditor.
      4 
      5   **Request:**
      6 
      7   :query progress_key: a string identifying a progress point. If specified, only returns the element with this exact key. The default value is NULL.
      8 
      9 
     10   **Response:**
     11 
     12   :http:statuscode:`200 OK`:
     13     The auditor responds with a :ts:type:`ProgressResponse` object. Its ``records`` field is empty if no matching elements were found.
     14   :http:statuscode:`400 Bad request`:
     15     The request is malformed. Returned with an
     16     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     17   :http:statuscode:`401 Unauthorized`:
     18     The request lacks valid authentication credentials.
     19     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     20   :http:statuscode:`500 Internal Server Error`:
     21     The server experienced an internal error.
     22     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED``,
     23     ``TALER_EC_GENERIC_DB_FETCH_FAILED``, or
     24     ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE`` error code.
     25 
     26   **Details:**
     27 
     28   .. ts:def:: ProgressResponse
     29 
     30     interface ProgressResponse {
     31 
     32       records: Progress[];
     33 
     34     }
     35 
     36   .. ts:def:: Progress
     37 
     38     interface Progress {
     39 
     40       // Key associated with a given progress point
     41       progress_key: string;
     42 
     43       // How much of the exchanges data has been processed so far
     44       progress_offset: SafeUint64;
     45 
     46     }