This method returns settings or preferences of the logged user (“me”) or any other user. The latter requires appropriate access rights. The properties are:
The user interface language
The user interface “culture” or date/time format
The time zone
URL
(POST) /api/persons/{uid}/settings?includeOptions=
(POST) /api/persons/me/settings?includeOptions=
PARAMETERS
The URL parameters are:
uid | Either pass a user ID or the shortcut “me” for the logged user. To find users, see persons/list | int or “me”, Mandatory |
includeOptions | Optional. Default is false if not specified.
| bool, Optional |
RESULTS
The result are a JSON object with these properties:
uid | The user ID. This is the user specified in the URL parameter. | int |
uname | The user name. | string |
language | The user interface language. This node includes code and print name. Example: "language": {
"v": "en",
"t": "English (en)"
}
| object |
culture | The date and time format. This node includes code and print name. Example: "culture": {
"v": "fr-FR",
"t": "French (France) (fr-FR)"
}
| object |
timezone | object | |
languages | All possible UI languages. This node is included if parameter includeOptions is true. A JSON array of options.: "languages": [
{ "v": "en", "t": "English" },
{ "v": "fr", "t": "French" },
...
]
| object[]? |
cultures | All possible date/time formats. This node is included if parameter includeOptions is true. A JSON array of options.: "cultures": [
{
"v": "ab",
"t": "Abkhazian"
},
{
"v": "ach",
"t": "Acholi"
},
{
"v": "adh-UG",
"t": "Adhola (Uganda)"
}
...
]
| |