GET Preference/{section}/{key}/{prefLevel}

• 2 minutes to read

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

Gets the preference value for specific section + key.

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
prefLevel	Enum: Undefined, HardDefault, SystemWide, Database, Group, Individual, PC	The level the preference is defined at. 0 or Undefined = the level closest to the user. 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:string

Response	Description
200	OK

Response body: string

Sample request

GET /api/v1/Preference/{section}/{key}/{prefLevel}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh

Sample response

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

"sint"