set_session_property

To configure some parameters of the current session, use the core/set_session_property method.

Copied!
svc=core/set_session_property&params={
  "prop_name": "<text>",
  "prop_value": "<text>"
}

Parameters

The allowed property names (prop_name):

  • skip_nonactive_items — allows hiding the deactivated objects (by default, all session objects are shown);
  • long_values — if set to 1, the server sends long numbers as strings (in brackets).

For both cases, the prop_value should be:

  • 1 — activate;
  • 2 — deactivate.

Example

Copied!
svc=core/set_session_property&params={"prop_name":"skip_nonactive_items","prop_value":"1"}

Response

If the request is completed successfully, an empty JSON is returned.

Copied!
{ }

If the request fails, an error code is returned.

Error codes

Error code Description
4 Wrong input parameters, or the property name isn’t allowed.
6 Session not found or failed to set property.

If you find a mistake in the text, please select it and press Ctrl+Enter.