Skip to main content
Aria Knowledge Central

get_acct_notification_details_m Sample Call and Response

This example retrieves the notification template groups assigned at various levels on an account, based on the get_acct_notification_details_m method as defined in plsql_m_r73.yml.

This example includes every required field; it does not cover every level at which a notification template group can be assigned.

Sample call

{
  "rest_call": "get_acct_notification_details_m",
  "output_format": "json",
  "client_no": 68219,
  "auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "acct_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 most methods in this batch, auth_key is explicitly required for this method. The account is identified with acct_no, the Aria-assigned numeric identifier, which is one of a group of three alternative identifiers (acct_no, acct_user_id, and client_acct_id); this example uses only acct_no and omits the other two. This example also omits do_logging_ind, since that field is marked nonpublic in the yml and carries no client-facing purpose.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "error_details": [],
  "acct_notification_details": [
    {
      "notify_tmplt_grp_id": "STD-NOTIFY-GRP",
      "notify_tmplt_grp_label": "Standard Account Notification Group",
      "notify_tmplt_grp_assign_lvl": "Account"
    },
    {
      "notify_tmplt_grp_id": "ENT-SUITE-NOTIFY-GRP",
      "notify_tmplt_grp_label": "Enterprise Suite Notification Group",
      "notify_tmplt_grp_assign_lvl": "Master Plan Instance"
    },
    {
      "notify_tmplt_grp_id": "BG-001-NOTIFY-GRP",
      "notify_tmplt_grp_label": "Billing Group 001 Notification Group",
      "notify_tmplt_grp_assign_lvl": "Billing Group"
    }
  ]
}

An error_code of zero and an error_msg of “OK” indicate that Aria found the account and returned its assigned notification template groups successfully. The acct_notification_details array shows three entries here, one assigned at the account level, one at the master plan instance level, and one at the billing group level, illustrating that notify_tmplt_grp_assign_lvl can vary by entry; an account with additional assignments would return further entries in the same array.

TOP
  • Was this article helpful?