GET /system/information/locales

Retrieve Locales.

Retrieves a list of all available locales. This endpoint is available to be called by every user or authorized service.

Table 1. GET /system/information/locales resource details
MIME Type
application/json

Table 2. GET /system/information/locales request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
sample_type	query	Optional	String	text/plain	null
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
sort	query	Optional	String	text/plain	Optional - This parameter is used to sort the elements in a list.

Table 3. GET /system/information/locales response codes
HTTP Response Code	Unique Code	Description
200		The locales were retrieved.
422	38315001	Field in sort parameter does not exist.
422	38315002	Sorting not supported on field in sort parameter.
500	1020	An unexpected error has occurred.

Response Description

Returns an array of locale structures.

id - String - The Internet Engineering Task Force (IETF) language tag of the locale.
label - String - The localized name of the locale.
label_in_own_locale - String - The name for the language in its own language form.
has_translation - boolean - Indicates if a translation exists for the locale.
sample - String - The type of the sample requested along with the locales. The only supported type of sample is NUMBER.

Response Sample


[
  {
    "id": "sq",
    "label": "Albanian",
    "label_in_own_locale": "shqip",
    "has_translation": "false",
    "sample": "1 234 567,89",
    
  },
  {
    "id": "sq-AL",
    "label": "Albanian (Albania)",
    "label_in_own_locale": "shqip (Shqipëria)",
    "has_translation": "false",
    "sample": "1 234 567,89"
  },
  {
    "id": "ar",
    "label": "Arabic",
    "label_in_own_locale": "العربية",
    "has_translation": "false",
    "sample": "١٬٢٣٤٬٥٦٧٫٨٩"
  },
  {
    "id": "ar-DZ",
    "label": "Arabic (Algeria)",
    "label_in_own_locale": "العربية (الجزائر)",
    "has_translation": "false",
    "sample": "1.234.567,89"
  },
  {
    "id": "ar-BH",
    "label": "Arabic (Bahrain)",
    "label_in_own_locale": "العربية (البحرين)",
    "has_translation": "false",
    "sample": "١٬٢٣٤٬٥٦٧٫٨٩"
  }
 ]