get-monitoring-wire-format-inconsistency.rst (2128B)
1 .. http:get:: /monitoring/wire-format-inconsistency 2 3 Get a list of wire format inconsistencies stored by the auditor. 4 5 The following query parameters are optional, and can be used to customise the response: 6 7 **Request:** 8 9 :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. 10 :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. 11 :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. 12 13 With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed. 14 15 **Response:** 16 17 :http:statuscode:`200 OK`: 18 The auditor responds with a top level array of :ts:type:`WireFormatInconsistency` objects. If no elements could be found, an empty array is returned 19 :http:statuscode:`400 Bad request`: 20 The request is malformed. Returned with an 21 ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code. 22 :http:statuscode:`401 Unauthorized`: 23 The request lacks valid authentication credentials. 24 The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``. 25 :http:statuscode:`500 Internal Server Error`: 26 The server experienced an internal error. 27 The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or 28 ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code. 29 30 31 **Details:** 32 33 .. ts:def:: WireFormatInconsistency 34 35 interface WireFormatInconsistency { 36 37 // Unique row identifier 38 row_id : Integer; 39 40 // Amount that was part of the wire 41 amount : Amount; 42 43 // Offset of the duplicate wire transfer subject 44 // in the bank database according to the revenue API. 45 wire_offset : Integer; 46 47 // True if this diagnostic was suppressed. 48 diagnostic : string; 49 50 // True if this diagnostic was suppressed. 51 suppressed : boolean; 52 53 54 } 55 56 .. note:: 57 58 This endpoint is still experimental. The endpoint will be further developed as needed.