persons/{uid}/settings
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
(GET) /api/persons/{uid}/settings?includeOptions=
(GET) /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:
CODE
| object |
culture | The date and time format. This node includes code and print name. Example:
CODE
| object |
timezone | The time zone with detailed information. Please see Time zone properties | object |
languages | All possible UI languages. This node is included if parameter includeOptions is true. A JSON array of options.:
CODE
| object[]? |
cultures | All possible date/time formats. This node is included if parameter includeOptions is true. A JSON array of options.:
CODE
| object[]? |
timezones | All possible time zones. This node is included if parameter includeOptions is true. A JSON array of time zones. See Time zone properties for each time zone’s properties. | object[]? |
EXAMPLES
A typical example for a user and when “includeOptions” is not set to true.
{
"uid": 562,
"uname": "John Wick",
"cid": 537,
"language": {
"v": "en",
"t": "English (en)"
},
"culture": {
"v": "fr-FR",
"t": "French (France) (fr-FR)"
},
"timezone": {
"id": "Romance Standard Time",
"name": "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris",
"currentName": "Romance Daylight Time",
"currentDate": "2022-05-11T17:28:12.4421194+00:00",
"currentOffset": "02:00:00",
"supportsDaylightSaving": true
}
}