Get Locale Information

get

/api/core/Locales/read/{LocaleValue}

Gets information about the locale that matches the specified ID. The ID corresponds to the LocaleName returned by the Get Locales for Combo Boxes and Item Selectors endpoint. The default en_US locale is ignored and will return no data.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : coreLocalesRead
Type: object
Show Source
  • The locale ID.
    Example: en_US
  • Lang
    A key-value pair. The key is an English word and the value is the corresponding word in another language.
Nested Schema : Lang
Type: object
A key-value pair. The key is an English word and the value is the corresponding word in another language.
Example:
{
}

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
An error.
Back to Top