Skip to main content
Aria Knowledge Central

get_acct_notify_method_m Sample Call and Response

This example retrieves the method by which statements are sent to a specified account, based on the get_acct_notify_method_m method as defined in plsql_m_r73.yml.

This example includes every required field. Because this method accepts only an account identifier, there are no optional fields to add to the call.

Sample call

{
  "rest_call": "get_acct_notify_method_m",
  "output_format": "json",
  "client_no": 68219,
  "auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "account_no": 5004123
}

The rest_call and output_format fields are envelope fields that the REST layer adds; they do not appear in the method's own arguments list. Unlike the other methods in this batch, this method names its account identifier argument account_no rather than acct_no; the value is the same kind of Aria-assigned numeric identifier, used here instead of its alternative, client_acct_id.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "error_details": [],
  "notify_method": 1,
  "notify_method_name": "HTML Email"
}

An error_code of zero and an error_msg of “OK” indicate that Aria found the account and returned its notification method successfully. A notify_method value of one, paired with the notify_method_name of “HTML Email”, means the account receives statements by HyperText Markup Language email. Other values in the same enumeration cover None, Text Email, Text Email with a link to HTML, Data export, Printable (no email, with and without a surcharge), Printable and Text Email, Printable and HTML Email with a surcharge, and PDF delivery either by printing, by email, or both, some combined with a surcharge. This response describes a single value rather than a repeatable array, since an account has exactly one notify method at a time.

TOP
  • Was this article helpful?