list_transaction_types_m Sample Call and Response
This example calls list_transaction_types_m to retrieve the catalog of transaction types recorded by Aria Systems, based on the Object Query API definition in app_m_r73.yml (release seventy-three). These are the same transaction type codes referenced elsewhere in the platform, for example in the transaction_type_no field returned by get_transaction_information_m.
This example includes every required argument, plus a representative set of three transaction type entries out of the full catalog, rather than an exhaustive field reference.
Sample call
{
"rest_call": "list_transaction_types_m",
"output_format": "json",
"client_no": 60123,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"limit": 50,
"offset": 0
}
The rest_call and output_format fields form the REST envelope, with output_format also documented in param_defaults as an optional field defaulting to wddx, so json must be requested explicitly. The client_no and auth_key fields are the required identifiers for this call. Unlike most methods in this family, this method’s own query_string argument is documented as nullable: true, so it is optional here; this example omits it because no field in the method’s returns section is marked queryable: true, so there is no documented field to filter this catalog on, and the call instead simply lists the available transaction types up to the limit. The optional limit and offset fields are included to show typical paging usage, with a higher limit than the other list methods in this family because Aria Systems records a larger number of distinct transaction types.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"starting_record": 0,
"total_records": 34,
"map_record": [
{
"number": 1,
"description": "Invoice"
},
{
"number": 5,
"description": "Electronic Payment"
},
{
"number": 12,
"description": "Electronic Refund"
}
]
}
An error_code of zero with an error_msg of “OK” indicates that the call succeeded. The starting_record value of zero and total_records value of thirty-four indicate that Aria Systems records thirty-four distinct transaction types in total, of which only three representative entries are shown here; a caller could retrieve the remaining entries by increasing offset or limit. Each map_record entry pairs an Aria-assigned numeric identifier (number) with the transaction type’s name (description); this identifier is the same value returned as transaction_type_no by methods such as get_transaction_information_m and get_refund_information_m. This example does not attempt to list all thirty-four transaction types, since the point of this page is to illustrate the shape of the response rather than to serve as a complete catalog reference.