taler-docs

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

patch-monitoring-aml-holds-SERIAL_ID.rst (1526B)

      1 .. http:patch:: /monitoring/aml-holds/$SERIAL_ID
      2 
      3   This endpoint is used to suppress select elements of the AML hold list.
      4   Update the 'suppressed' field of an AML hold element with row_id $SERIAL_ID, according to :ts:type:`GenericAuditorMonitorPatchRequest`, stored by the auditor.
      5 
      6   Note that suppressing a hold only hides it from this listing.  The funds are
      7   withheld either way, so the amount continues to count towards the
      8   ``total_aml_hold`` and ``total_transfer_lag`` balances.
      9 
     10   **Response:**
     11 
     12   :http:statuscode:`204 No Content`:
     13     The element has been updated.
     14   :http:statuscode:`400 Bad Request`:
     15     The request body is invalid or the ``$SERIAL_ID`` is not a valid row identifier.
     16     The response comes with a ``TALER_EC_GENERIC_JSON_INVALID`` or
     17     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     18   :http:statuscode:`401 Unauthorized`:
     19     The request lacks valid authentication credentials.
     20     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     21   :http:statuscode:`404 Not found`:
     22     The specified row was not found.
     23     The response comes with a ``TALER_EC_AUDITOR_RESOURCE_NOT_FOUND`` error code.
     24   :http:statuscode:`500 Internal Server Error`:
     25     The server experienced an internal error.
     26     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED``,
     27     ``TALER_EC_GENERIC_DB_STORE_FAILED``, or
     28     ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE`` error code.
     29 
     30   .. note::
     31 
     32     This endpoint is still experimental. The endpoint will be further developed as needed.