POST Agents/Preference/GetPreference

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Preference/GetPreference

Get a preference by id

NsApiSlow threshold: 1000 ms.

Query String Parameters

Parameter Name Type Description
$select string 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. 
POST /api/v1/Agents/Preference/GetPreference?$select=name,department,category/id

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
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
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.

Request Body: request

Id

Property Name Type Description
Id Integer

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

POST /api/v1/Agents/Preference/GetPreference
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "Id": 399
}

Sample response

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

{
  "Level": "Database",
  "RawValue": "true",
  "Specification": null,
  "DisplayValue": "Enabled",
  "DisplayTooltip": "Show notifications for new appointments",
  "DisplayType": "Bool",
  "TabOrder": null,
  "TargetId": 162,
  "PrefDescId": 69,
  "TableName": "UserPreference",
  "UserPreferenceId": 309,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 372
    }
  }
}