Get locale configuration - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

This web service returns all locale information set for the portal.

Method Endpoint
GET
/api/locales

Response body

{
  "defaultLocales": {
    "defaultUiLocale": {
      "lang": "en",
      "region": "US"
    },
    "defaultContentLocale": {
      "lang": "en",
      "region": "US"
    },
    "defaultRegions": [
      {
        "lang": "af",
        "region": "ZA"
      },
      {
        "lang": "ar",
        "region": "MA"
      },
      {
        "lang": "be",
        "region": "BY"
      },
      {
        "lang": "bg",
        "region": "BG"
      },
      {
        "lang": "ca",
        "region": "ES"
      },
      {
        "lang": "cs",
        "region": "CZ"
      },
      {
        "lang": "da",
        "region": "DK"
      },
      {
        "lang": "de",
        "region": "DE"
      },
      {
        "lang": "el",
        "region": "GR"
      },
      {
        "lang": "en",
        "region": "US"
      },
      {
        "lang": "es",
        "region": "ES"
      },
      {
        "lang": "et",
        "region": "EE"
      },
      {
        "lang": "eu",
        "region": "ES"
      },
      {
        "lang": "fa",
        "region": "IR"
      },
      {
        "lang": "fi",
        "region": "FI"
      },
      {
        "lang": "fo",
        "region": "FO"
      },
      {
        "lang": "fr",
        "region": "FR"
      },
      {
        "lang": "gl",
        "region": "ES"
      },
      {
        "lang": "gu",
        "region": "IN"
      },
      {
        "lang": "he",
        "region": "IL"
      },
      {
        "lang": "hi",
        "region": "IN"
      },
      {
        "lang": "hr",
        "region": "HR"
      },
      {
        "lang": "hu",
        "region": "HU"
      },
      {
        "lang": "hy",
        "region": "AM"
      },
      {
        "lang": "id",
        "region": "ID"
      },
      {
        "lang": "is",
        "region": "IS"
      },
      {
        "lang": "it",
        "region": "IT"
      },
      {
        "lang": "ja",
        "region": "JP"
      },
      {
        "lang": "ka",
        "region": "GE"
      },
      {
        "lang": "kk",
        "region": "KZ"
      },
      {
        "lang": "kn",
        "region": "IN"
      },
      {
        "lang": "ko",
        "region": "KR"
      },
      {
        "lang": "ky",
        "region": "KZ"
      },
      {
        "lang": "lt",
        "region": "LT"
      },
      {
        "lang": "lv",
        "region": "LV"
      },
      {
        "lang": "mk",
        "region": "MK"
      },
      {
        "lang": "mn",
        "region": "MN"
      },
      {
        "lang": "mr",
        "region": "IN"
      },
      {
        "lang": "ms",
        "region": "MY"
      },
      {
        "lang": "nb",
        "region": "NO"
      },
      {
        "lang": "nl",
        "region": "NL"
      },
      {
        "lang": "nn",
        "region": "NO"
      },
      {
        "lang": "no",
        "region": "NO"
      },
      {
        "lang": "pa",
        "region": "IN"
      },
      {
        "lang": "pl",
        "region": "PL"
      },
      {
        "lang": "pt",
        "region": "BR"
      },
      {
        "lang": "ro",
        "region": "RO"
      },
      {
        "lang": "ru",
        "region": "RU"
      },
      {
        "lang": "sa",
        "region": "IN"
      },
      {
        "lang": "sk",
        "region": "SK"
      },
      {
        "lang": "sl",
        "region": "SI"
      },
      {
        "lang": "sq",
        "region": "AL"
      },
      {
        "lang": "sr",
        "region": "RS"
      },
      {
        "lang": "sv",
        "region": "SE"
      },
      {
        "lang": "sw",
        "region": "KE"
      },
      {
        "lang": "ta",
        "region": "IN"
      },
      {
        "lang": "te",
        "region": "IN"
      },
      {
        "lang": "th",
        "region": "TH"
      },
      {
        "lang": "tr",
        "region": "TR"
      },
      {
        "lang": "tt",
        "region": "RU"
      },
      {
        "lang": "uk",
        "region": "UA"
      },
      {
        "lang": "ur",
        "region": "PK"
      },
      {
        "lang": "vi",
        "region": "VN"
      },
      {
        "lang": "zh",
        "region": "CN"
      }
    ]
  },
  "availableUiLocales": [
    {
      "languageTag": "en-US",
      "displayName": "English (United States)",
      "translated": true
    },
    {
      "languageTag": "fr-FR",
      "displayName": "Français (France)",
      "translated": true
    },
    {
      "languageTag": "de-DE",
      "displayName": "Deutsch (Deutschland)",
      "translated": true
    },
    {
      "languageTag": "ja-JP",
      "displayName": "日本語 (日本)",
      "translated": true
    },
    {
      "languageTag": "it-IT",
      "displayName": "Italiano (Italia)",
      "translated": true
    }
  ],
  "allLanguagesAllowed": false
}
Parameter Type Description
defaultLocales Object The default language ISO code for the portal interface.
defaultUiLocale Object The default language ISO code for the portal interface.
defaultContentLocale Object The default language ISO code for the portal content.
defaultRegions Array ISO codes for default regional languages. For example, if users upload content with a ft:locale metadata value set to en, Fluid Topics completes en with the configured default region: US. The value of the ft:locale metadata becomes en-US.
availableUiLocales Array Describes the interface languages available on the portal.
languageTag String The IETF language tag for a language.
displayName String The full display name for the language, as displayed in the Interface language selector component, for example.
translated Boolean Indicates if Fluid Topics provides default labels in this language.
allLanguagesAllowed Boolean Is true when the Search in all languages option is active.
Return code Description
200 OK Returns 0 or more results.