Overview

Retrieves user locale settings.

Summary

This endpoint will return a set of locale settings, formatted as options, for the requested user.

Request Arguments

Name Type Description Required
user_id String The ID of the user Yes

Response

    
        {
            "appearance": [
                0: {name: "system_default", label: "Use system setting", selected: false}
                1: {name: "light", label: "Light", selected: true}
                2: {name: "dark", label: "Dark", selected: false}
            ],
            "currency": "-99",
            "currencyOptions": [
                0: {id: -99, label: "$ - US Dollars", selected: true}
                1: {id: "2545ecc8-330a-11ec-8e87-0242ac140008", label: "€ - Euro", selected: false}
            ],
            "dateOptions": [
                0: {name: "Y-m-d", label: "2010-12-23", selected: false}
                1: {name: "m-d-Y", label: "12-23-2010", selected: false}
            ],
            "datef": "m.d.Y",
            "decSep": ".",
            "defaultCurrencySignificantDigits": "3",
            "defaultLocaleNameFormat": "s l",
            "nameOptions": [
                0: {name: "s f l", label: "Dr. David Livingstone", selected: false}
                1: {name: "f l", label: "David Livingstone", selected: false}
                2: {name: "s l", label: "Dr. Livingstone", selected: true}
            ],
            "numGrpSep": ",",
            "sigDigitsOptions": [
                0: {name: 0, selected: false}
                1: {name: 1, selected: false}
                2: {name: 2, selected: false}
                3: {name: 3, selected: true}
            ],
            "timeOptions": [
                0: {name: "H:i", label: "23:00", selected: false}
                1: {name: "h:ia", label: "11:00pm", selected: false}
                2: {name: "h:iA", label: "11:00PM", selected: false}
            ],
            "timef": "h.i A",
            "timezone": "Europe/Bucharest",
            "timezoneOptions": [
                0: {name: "Pacific/Midway", label: "Pacific/Midway (GMT-11:00)", selected: false}
                1: {name: "Pacific/Niue", label: "Pacific/Niue (GMT-11:00)", selected: false}
                2: {name: "Pacific/Pago_Pago", label: "Pacific/Pago Pago (GMT-11:00)", selected: false}
            ],
            "ut": true,
            "wizardPrompt": false,
        }

Change Log

Version Change
v11_15 Added /userUtilities/getLocalesData/:user_id GET endpoint.