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
-
LocaleValue(required): string
The ID of the locale.Example:
en_DEBUG
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : coreLocalesRead
Type:
Show Source
object
-
ID: string
The locale ID.Example:
en_US
-
Lang: object
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
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.