taler-docs

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

post-management-aml-officers.rst (1692B)

      1 .. http:post:: /management/aml-officers
      2 
      3   Update settings for an AML Officer status.
      4 
      5   **Request:**
      6 
      7   The request must be an `AmlOfficerSetup` message.
      8 
      9   **Response:**
     10 
     11   :http:statuscode:`204 No content`:
     12     The officer settings have been updated successfully.
     13   :http:statuscode:`403 Forbidden`:
     14     The signature is invalid.
     15     Returned with an error code of
     16     ``TALER_EC_EXCHANGE_MANAGEMENT_UPDATE_AML_OFFICER_SIGNATURE_INVALID``
     17   :http:statuscode:`409 Conflict`:
     18     The exchange has previously received a conflicting configuration message.
     19     Returned with an error code of
     20     ``TALER_EC_EXCHANGE_MANAGEMENT_AML_OFFICERS_MORE_RECENT_PRESENT``
     21   :http:statuscode:`413 Request entity too large`:
     22     The uploaded body is to long, it exceeds the size limit.
     23     Returned with an error code of
     24     ``TALER_EC_GENERIC_UPLOAD_EXCEEDS_LIMIT``.
     25   :http:statuscode:`500 Internal Server Error`:
     26     The server experienced an internal error.
     27     This response comes with a standard `ErrorDetail` response with
     28     a code of ``TALER_EC_GENERIC_DB_STORE_FAILED``.
     29 
     30   **Details:**
     31 
     32   .. ts:def:: AmlOfficerSetup
     33 
     34     interface AmlOfficerSetup {
     35 
     36       // Public key of the AML officer
     37       officer_pub: EddsaPublicKey;
     38 
     39       // Legal full name of the AML officer
     40       officer_name: string;
     41 
     42       // Is the account active?
     43       is_active: boolean;
     44 
     45       // Is the account read-only?
     46       read_only: boolean;
     47 
     48       // Signature by the exchange master key over a
     49       // `TALER_MasterAmlOfficerStatusPS`.
     50       // Must have purpose ``TALER_SIGNATURE_MASTER_AML_KEY``.
     51       master_sig: EddsaSignature;
     52 
     53       // When will the change take effect?
     54       change_date: Timestamp;
     55 
     56     }