Skip to main content
Get Preferences

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.

Response

OK

Search preferences for a phone list search Carrier object for PhoneListPreferences. Services for the PhoneListPreferences Carrier is available from the PhoneList Agent.

SearchCompany
boolean

True if you want to search for Companies by their name.

SearchFirstname
boolean

True if you want to search for Persons by their firstname.

SearchLastname
boolean

True if you want to search for Persons by their lastname.

SearchDepartment
boolean

True if you want to search for Departments where your colleagues work.

SearchModeCompany
enum<string>

The Company name search type, e.g. BeginsWith, Contains, Endswith, Matches

Available options:
Exact,
BeginsWith,
EndsWith,
Contains
SearchModeDepartment
enum<string>

The Department search type, e.g. BeginsWith, Contains, Endswith, Matches

Available options:
Exact,
BeginsWith,
EndsWith,
Contains
SearchModeFirstname
enum<string>

The firstname search type, e.g. BeginsWith, Contains, Endswith, Matches

Available options:
Exact,
BeginsWith,
EndsWith,
Contains
SearchModeLastname
enum<string>

The lastname search type, e.g. BeginsWith, Contains, Endswith, Matches

Available options:
Exact,
BeginsWith,
EndsWith,
Contains
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.