Skip to main content
Post Preference Description

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$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.

Body

The PreferenceDescription to be saved.

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice. Carrier object for PreferenceDescription. Services for the PreferenceDescription Carrier is available from the Preference Agent.

PrefDescId
integer<int32>

Primary key

Section
string

Preference section name

Key
string

Preference key name

Name
string

Multi-language name

ValueType
enum<string>

1=number, 2=text, 3=bool, 4=list of values; 5=list table ref; 6=contact ID, 7=Person ID, 8=Project ID, 9=Selection ID

Available options:
Unknown,
Number,
Text,
Bool,
ListOfValues,
ListTableRef,
TimeList,
ContactID,
PersonID,
ProjectID,
SelectionID,
PosSize,
TimeZone,
Time,
Password,
MultiLineText
MaxLevel
enum<string>

Lowest allowed setting level, set by user, but not lower than sysMaxLevel

Available options:
Undefined,
HardDefault,
SystemWide,
Database,
Group,
Individual,
PC
SysMaxLevel
enum<string>

Lowest allowed setting level, set by SuperOffice

Available options:
Undefined,
HardDefault,
SystemWide,
Database,
Group,
Individual,
PC
AccessFlags
enum<string>

1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui

Available options:
Unknown,
WizardMode,
Level0,
adminGUI,
CRMGUI
Description
string

Description of preference, multi-language parsed

IsBuiltin
boolean

1 = This row populated and maintained by SuperOffice

TableName
string

If valueType = 5, then TableName contains the table referenced by the preference

UserDefinedListId
integer<int32>

Read-only field, If valueType = 5, and TableName is UDList, then UserdefinedLIstId contains the id of the list referenced by the preference

Rank
integer<int32>

Rank field for ordering sections, and keys within sections

SubGroup
string

Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups

MinLevel
integer<int32>

The minimum (furthest away from User) level this preference can be set for

MaxValue
integer<int32>

Max value (if type 1); list table ID (if type 5)

MinValue
integer<int32>

Min value (if type 1); list extra id (if type 5)

RequiredLicense
string

Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.

Response

OK

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice. PreferenceDescription entity with API _Links added.

PrefDescId
integer<int32>

Primary key

Section
string

Preference section name

Key
string

Preference key name

Name
string

Multi-language name

ValueType
enum<string>

1=number, 2=text, 3=bool, 4=list of values; 5=list table ref; 6=contact ID, 7=Person ID, 8=Project ID, 9=Selection ID

Available options:
Unknown,
Number,
Text,
Bool,
ListOfValues,
ListTableRef,
TimeList,
ContactID,
PersonID,
ProjectID,
SelectionID,
PosSize,
TimeZone,
Time,
Password,
MultiLineText
MaxLevel
enum<string>

Lowest allowed setting level, set by user, but not lower than sysMaxLevel

Available options:
Undefined,
HardDefault,
SystemWide,
Database,
Group,
Individual,
PC
SysMaxLevel
enum<string>

Lowest allowed setting level, set by SuperOffice

Available options:
Undefined,
HardDefault,
SystemWide,
Database,
Group,
Individual,
PC
AccessFlags
enum<string>

1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui

Available options:
Unknown,
WizardMode,
Level0,
adminGUI,
CRMGUI
Description
string

Description of preference, multi-language parsed

IsBuiltin
boolean

1 = This row populated and maintained by SuperOffice

TableName
string

If valueType = 5, then TableName contains the table referenced by the preference

UserDefinedListId
integer<int32>

Read-only field, If valueType = 5, and TableName is UDList, then UserdefinedLIstId contains the id of the list referenced by the preference

Rank
integer<int32>

Rank field for ordering sections, and keys within sections

SubGroup
string

Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups

MinLevel
integer<int32>

The minimum (furthest away from User) level this preference can be set for

MaxValue
integer<int32>

Max value (if type 1); list table ID (if type 5)

MinValue
integer<int32>

Min value (if type 1); list extra id (if type 5)

RequiredLicense
string

Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.