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&target=user&action=update_user_prefs&change_reason=ON&hide_help_btn=0&save_position=1&login_name=admin

Parameters

ParameterDescription
targetuser
actionupdate_user_prefs
change_reasonA user preferences make change highlight active (shown) or passive (invisible). This parameter can accept the values ON or OFF.
hide_help_btnA setting that will either hide or show the context sensitive help buttons. Either "0" or "1".
save_positionA setting that will cause a user's size and position of the client window to be saved. Either "0" or "1".
idA 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_nameThe user whose preferences are being updated
collectionThe name of the collection that the publication is registered in, such as default.

Returns

On success
Nothing.
On failure
Nothing.