replace_reg_uss_params_m Sample Call and Response
This example shows a call that replaces the parameter name-value pairs associated with a particular application session with a specified set of new parameter name-value pairs, based on the replace_reg_uss_params_m method defined in plsql_m_r73.yml. This method operates on a client-assigned session_id, which is distinct from the named configuration sets that replace_reg_uss_config_params_m manages.
This example includes every required field for the method; it leaves out the internal-use-only override_timeout_minutes field.
Sample call
{
"rest_call": "replace_reg_uss_params_m",
"output_format": "json",
"client_no": 66123,
"auth_key": "sample-auth-key-not-real-000111",
"session_id": "sess-88451207-checkout",
"in_reg_uss_params": [
{
"param_name": "cart_step",
"param_val": "payment_review"
},
{
"param_name": "selected_plan_no",
"param_val": "71850"
}
]
}
The session_id field identifies the client-assigned application session whose parameters are being replaced. The in_reg_uss_params field is an array, since a session holds more than one name-value pair; this example includes two representative entries. Every param_name and param_val pair supplied in this array replaces the entire prior contents of the session's parameter set, so any parameter not included here is removed. The auth_key and output_format fields sit outside the method's own documented arguments; auth_key authenticates the caller, and output_format, together with rest_call, forms the envelope that the REST gateway adds to every call, requesting a JSON response.
Sample response
{
"error_code": 0,
"error_msg": "OK"
}
An error_code value of 0 and an error_msg value of "OK" indicate that Aria successfully replaced the parameters for the specified session. This method returns no fields beyond the error indicators; this example does not include the error_details field, since that field is for internal use and does not appear in a client-facing response. This example also leaves out the override_timeout_minutes field from the call, since that field is marked for internal use only and is not acted on for a client-supplied value.