Skip to content

Retrieve the default locale

View as Markdown
get /api/default_locale

Retrieves a DefaultLocale resource.

Returns the locale currently set as the default for your catalog, as a code such as fr-FR. There is always exactly one default locale.

Response

200 - DefaultLocale resource

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
codestring | null-The code of the current default locale.

Errors

403 - Access denied. The caller is missing one or more identity permissions required for this operation.

Content-Type: application/problem+json

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
typestring-
titlestring-
statusinteger-
detailstring-
missingPermissionsstring[]-Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.

404 - Not found

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
titlestring | null-A short, human-readable summary of the problem.
detailstring | null-A human-readable explanation specific to this occurrence of the problem.
statusinteger | null-
instancestring | null-A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
typestring-A URI reference that identifies the problem type
descriptionstring | null-