Set user preferences
This API call sets the available preferences for the user specified in the login_name parameter. These user preferences persist between LiveContent S1000D sessions and are focused on differences in the presentation of content or the application.
Example API call
/servlets3/wietmsd?id=1459781625534&book=s1000d_bike_41&collection=default&uniqid=1459781624066&target=user&action=update_user_prefs&change_reason=ON&hide_help_btn=0&save_position=1&login_name=admin
Parameters
| Parameter | Description |
|---|---|
target | user |
action | update_user_prefs |
change_reason | A user preferences make change highlight active (shown) or passive (invisible). This parameter can accept the values ON or OFF. |
hide_help_btn | A setting that will either hide or show the context sensitive help buttons. Either "0" or "1". |
save_position | A setting that will cause a user's size and position of the client window to be saved. Either "0" or "1". |
id | A session ID that was retrieved with or without a specific collection and publication combination |
book | The name of the publication, such as s1000d_bike_41. |
login_name | The user whose preferences are being updated |
uniqid | To prevent browser-side caching of data, especially with AJAX requests, it is important to make a URL unique. The most effective technique to accomplish this is to include a date parameter that is based on the time at which the call is made. |
collection | The name of the collection that the publication is registered in, such as default. |
Returns
- On success
- Nothing.
- On failure
- Nothing.