Skip to main content
Aria Knowledge Central

get_supp_field_values_m Sample Call and Response

This example retrieves the stored values for a particular supplemental field associated with a specified account, based on the get_supp_field_values_m method defined in plsql_m_r73.yml.

This example includes every required field for a straightforward lookup by account number and supplemental field name. It does not cover every optional field the method accepts.

Sample call

{
  "rest_call": "get_supp_field_values_m",
  "output_format": "json",
  "client_no": 1275,
  "auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "acct_no": 900412233,
  "field_name": "preferred_contact_method"
}

The rest_call and output_format fields form the envelope that the REST layer adds to every call; they are not part of the method's own documented arguments. The acct_no field identifies the account and is one of two alternative fields for this purpose; this example uses the Aria-assigned acct_no rather than the client-defined client_acct_id. The field_name field is required and names the supplemental field whose stored values you want to retrieve.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "acct_supp_field_values": [
    "email",
    "sms"
  ]
}

An error_code of zero, together with an error_msg of "OK," indicates that Aria located the account and the supplemental field successfully. The acct_supp_field_values array holds the values currently stored in the specified supplemental field; this example shows two entries because a supplemental field can hold more than one value, and an actual response could contain additional entries beyond what is shown here. The method's yml definition also lists an older supp_field_values return field for the same purpose, but that field carries a deprecate_version of 6.25 and is also marked as unused in this release, so it is intentionally left out of this example in favor of acct_supp_field_values.

TOP
  • Was this article helpful?