Get Preference By Name
Get a preference by name
NsApiSlow threshold: 1000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
PrefSection, PrefKey, PrefLevel
Response
OK
One preference item, which contains a specification (section/key), the raw string value, and the level at which this value was found. Carrier object for Preference. Services for the Preference Carrier is available from the Preference Agent.
Preference level, using the standard enumerated type. Undefined is returned for preferences that do not have a current setting.
Undefined, HardDefault, SystemWide, Database, Group, Individual, PC Preference value
Preference specification, consisting of the section name and key name Carrier object for PreferenceSpec. Services for the PreferenceSpec Carrier is available from the Preference Agent.
Display value, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.
Display tooltip, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.
Display type, populated when asked for.
Unknown, Number, Text, Bool, ListOfValues, ListTableRef, TimeList, ContactID, PersonID, ProjectID, SelectionID, PosSize, TimeZone, Time, Password, MultiLineText Carrier object for TabOrder. Services for the TabOrder Carrier is available from the Preference Agent.
The id of the target row. The table it points at is specified by the preference type.
The id of the prefdesc this preference is connected to
For DisplayType=PrefDescValueType.ListTableRef, TableName will contain the name of the table which the value reference to.
The id of the user preference
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Preference By Name And IdNSPreferenceAgentGet PreferencesGet PreferenceNSPreference