close anchor

Project Locales

To get information on project locales:

GET /project/locales

Parameters

Param Type Description Optional
id string The identifier of an Elebase project locale, being one of those provided by the /locales endpoint identified with the Elebase project for this endpoint transaction.
default boolean Indicate whether or not to filter project locales based on this property. Include a value of either true or false to identify the locale(s) to be provided.
enabled boolean Indicate whether or not to filter project locales based on this property. Include a value of either true or false to identify the locale(s) to be provided.
optional boolean Indicate whether or not to filter project locales based on this property. Include a value of either true or false to identify the locale(s) to be provided.
fallback string The identifier of a project locale by which to filter. If provided with a non-empty value, project locale(s) for which this locale is explicitly identified as the fallback locale will be included, but not those for which this locale would be inferred (if, for example, the default project locale would be inferred for a locale but is not explicitly identified as the fallback, that locale will not be included).
path string The identifier of a project locale by which to filter. If provided with a non-empty value, project locale(s) for which this locale exists in the fallback path will be included, whether or not this locale is explicitly identified as the fallback locale thereof (in other words, each project locale for which this locale exists in its fallback path will be included).
data string Indicate, by providing a comma-delimited list, the data field(s) to be delivered by this endpoint. If empty or not provided, this endpoint will include by default each of the data field(s) identified with the project locale object.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of project locale object(s).

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_project_locale The locale indicated does not exist or is not identified with this project. The data included for this error will be an object with the project ID and the locale indicated.

If an error is not described on this page, the platform-wide error table provides further information.

To post a project locale:

POST /project/locales

In order to post a project locale, log in a user identified with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
id string The identifier of a known Elebase locale to be identified with the project, being one of those provided by the /locales endpoint.
enabled boolean Indicate whether or not the project locale is to be enabled.
optional boolean Indicate whether the project locale is to be treated as optional in terms of whether a non-empty value is expected before an entry would qualify for publication by an editor.
fallback string The identifier of the project locale for which data ought to be provided if no text value exists yet in this locale.

The data object provided by this endpoint is the project locale object inserted to the project.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_fallback_locale The fallback locale does not exist or is not identified with this project. The data included for this error will be, if the former, the locale provided or, if the latter, an object with the project ID and the locale indicated.
invalid_locale The locale identifier provided does not exist or is not known on the Elebase platform.
project_locale_exists The locale indicated exists and is identified with this project. The data included for this error will be an object with the project ID and the locale indicated.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update a project locale:

PUT /project/locales

In order to update a project locale, log in a user identified with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
id string The identifier of the project locale for which data is being updated.
default boolean Indicate whether this ought to be the default locale for the project. If true, the existing default project locale will no longer be, and this locale will be enabled and include no fallback locale in the project.
enabled boolean Indicate whether or not the project locale is to be enabled. If this is the default project locale, a value of true will be inferred.
optional boolean Indicate whether the project locale is to be treated as optional in terms of whether a non-empty value is expected before an entry would qualify for publication by an editor. If this is the default project locale, a value of false will be inferred.
fallback string The identifier of the project locale for which data ought to be provided if no text value exists yet in this locale.

The data object provided by this endpoint is the updated project locale object.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_fallback_locale The fallback locale indicated is not identified with this project. The data included for this error will be an object with the project ID and the locale indicated.
invalid_fallback_locale_graph The fallback locale indicated exists in the fallback locale path identified with this locale for the project. In order to prevent an infinite loop, do not indicate a fallback locale for which this locale would be a fallback, too, even indirectly.
invalid_locale The locale identifier provided does not exist or is not known on the Elebase platform.
invalid_project_locale The locale is not identified with this project. The data included for this error will be an object with the project ID and the locale indicated.

If an error is not described on this page, the platform-wide error table provides further information.

To delete a project locale:

DELETE /project/locales

In order to delete a project locale, log in a user identified with owner-level privileges.

Parameters

Param Type Description
id string The identifier of the project locale to be deleted.

The data object provided by this endpoint is the deleted project locale.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_locale The locale identifier provided does not exist or is not known on the Elebase platform.
invalid_project_locale The locale indicated does not exist, is not identified with this project, or is the default project locale and therefore not to be deleted. The data included for this error will be an object with the project ID and the locale indicated.

If an error is not described on this page, the platform-wide error table provides further information.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*