GET Preference/{section}/{key}

Some tooltip text!

• 3 minutes to read

 • 3 minutes to read

GET /api/v1/Preference/{section}/{key}

Gets the preference value for specific section + key.

Returns the value defined closest to the user. Calls the Preference agent service GetPreferenceByName.

Path Part	Type	Description
section	string	The name of the preference section. Required
key	string	The name of the preference key. Required

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept	Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response	Description
200	OK

Response body: Preference

Property Name	Type	Description
Level	string	Preference level, using the standard enumerated type. Undefined is returned for preferences that do not have a current setting.
RawValue	string	Preference value
Specification	PreferenceSpec	Preference specification, consisting of the section name and key name
DisplayValue	string	Display value, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.
DisplayTooltip	string	Display tooltip, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.
DisplayType	string	Display type, populated when asked for.
TabOrder	TabOrder	Carrier object for TabOrder. Services for the TabOrder Carrier is available from the Preference Agent.
TargetId	int32	The id of the target row. The table it points at is specified by the preference type.
PrefDescId	int32	The id of the prefdesc this preference is connected to
TableName	string	For DisplayType=PrefDescValueType.ListTableRef, TableName will contain the name of the table which the value reference to.
UserPreferenceId	int32	The id of the user preference
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.

Sample request

GET /api/v1/Preference/{section}/{key}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Level": "Database",
  "RawValue": "a",
  "Specification": null,
  "DisplayValue": "consequatur",
  "DisplayTooltip": "explicabo",
  "DisplayType": "Bool",
  "TabOrder": null,
  "TargetId": 748,
  "PrefDescId": 315,
  "TableName": "Reinger-Hahn",
  "UserPreferenceId": 884,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 485
    }
  }
}