Skip to main content
Aria Knowledge Central

get_web_replacement_vals_m Sample Call and Response

This example retrieves the current values for an array of client-configured web replacement strings, based on the method definition in plsql_m_r73.yml.

This example includes every field the method accepts, since the method takes only one input argument beyond the standard client_no and auth_key fields.

Sample call

{
  "rest_call": "get_web_replacement_vals_m",
  "output_format": "json",
  "client_no": 10023,
  "auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "web_vals_in": [
    { "in_replacement_names": "CLIENT_SUPPORT_EMAIL" },
    { "in_replacement_names": "CLIENT_SUPPORT_PHONE" }
  ]
}

The envelope fields rest_call and output_format are added by the REST layer and are not part of the method’s own documented arguments. The web_vals_in field is an array because it holds a list of replacement string names to look up; this example requests two names, but you may request more.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "error_details": "",
  "web_vals_out": [
    {
      "out_replacement_names": "CLIENT_SUPPORT_EMAIL",
      "out_replacement_values": "support@acmewireless.example.com"
    },
    {
      "out_replacement_names": "CLIENT_SUPPORT_PHONE",
      "out_replacement_values": "1-800-555-0142"
    }
  ]
}

An error_code of zero and an error_msg of OK indicate that the call succeeded. The web_vals_out array holds one entry per name requested in web_vals_in, each paired with its configured replacement value; this example shows two entries because the sample call requested two names.

TOP
  • Was this article helpful?