set
Set a session value
Description
Set a name and value on the current session. Only approved session names are allowed.
Parameters
- action
- set
- name
- The name of session attribute to set. If the name "lc.skin" is provided and the user has "Develop app" permissions, then this will set the current skin to the provided value.
- value
- The value of the session attribute
Example URL
http://<host>:<port>/<context>/web/session.xql?action=set&name=<value>&value=<value>
Successful Result
This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.
Failed Result
This may fail if invalid attribute names are user. Accessing this API feature requires the "Use application" permission, and the function will throw a permission exception if the permission is not available.