get_acct_plan_notify_method_m Sample Call and Response
This example shows a call that retrieves the notification method configured for a specific plan instance on an account, based on the plsql_m_r73.yml release definition for get_acct_plan_notify_method_m.
This example includes every required field, resolving the identifier alternatives with the Aria-assigned numeric fields, plus the returned notification method details. It does not cover every alternative identifier the method accepts.
Sample call
{
"rest_call": "get_acct_plan_notify_method_m",
"output_format": "json",
"client_no": 105,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 300224981,
"plan_instance_no": 88452201
}
The rest_call and output_format fields are not part of the method’s documented arguments; the REST gateway adds them to every call to identify the method being invoked and to request a JSON response. The method requires an account identifier, so this example supplies the Aria-assigned acct_no rather than the alternative client-defined client_acct_id. The method also requires exactly one of four alternative identifiers for the plan instance or billing group whose notification method you want: plan_instance_no, client_plan_instance_id, billing_group_no, or client_def_billing_group_id. This example supplies plan_instance_no, the Aria-assigned master plan instance number, and omits the other three alternatives.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"notify_method": 1,
"list_start_master_file": 0,
"notify_method_name": "HTML Email"
}
An error_code of zero with an error_msg of “OK” indicates that Aria located the plan instance and returned its notification method successfully. The notify_method field returns a numeric code; this example shows a value of one, which corresponds to HTML Email. Other values exist for this field, including None, Text Email, Text Email with a link to HTML, Data export, and several printable options. The list_start_master_file field returns zero, indicating that the account is not listed at the start of the master file; a value of one would indicate that it is. This example leaves out the nonpublic error_details field, which the method returns internally but which does not represent client-facing information.