REST PluginMultilingualism

Get, create, update translations.

Delete multiple translation

Deletes multiple translation. The pluginSetId and languageCode must be specified.

/rest/plugin_sets/{pluginSetId}/languages/{languageCode}

Parameters

Field Type Description
$pluginSetId Int The ID of the plugin set
$languageCode String The code of the language

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create a new translation

Creates a new translation.

/rest/languages/translations

Parameters

Field Type Description
$pluginSetId Int The ID of the plugin set
$pluginName String The name of the plugin
$languageCode String The language code for the translation
$key String The translation key
$value String The value of the translation
$fileName String The of the file

Success 200

Field Type Description
id Int The ID of the translation
pluginSetId Int The ID of the plugin set
pluginName String The name of the plugin
languageCode String The code of the language
fileName String The file of the key
key String The translation key
value String The translation value

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a translation

Gets a translation. The ID of the translation must be specified.

/rest/languages/translations/{translationId}

Parameters

Field Type Description
$id Int The ID of the translation

Success 200

Field Type Description
id Int The ID of the translation
pluginSetId Int The ID of the plugin set
pluginName String The name of the plugin
languageCode String The code of the language
fileName String The file of the key
key String The translation key
value String The translation value

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update a translation

Updates a translation. The ID of the translation must be specified

/rest/languages/translations/{translationId}

Parameters

Field Type Description
$id Int The ID of the translation
$pluginSetId Int The ID of the plugin set
$pluginName String The name of the plugin
$languageCode String The language code for the translation
$key String The translation key
$value String The value of the translation
$fileName String The value of the translation

Success 200

Field Type Description
id Int The ID of the translation
pluginSetId Int The ID of the plugin set
pluginName String The name of the plugin
languageCode String The code of the language
fileName String The file of the key
key String The translation key
value String The translation value

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete a translation

Deletes a translation. The ID of the translation must be specified.

/rest/languages/translations/{translationId}

Parameters

Field Type Description
$translationId Int The ID of the translation

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.