API

System APIs

PUT system/error-messages/{errorMessageId}/translations

Creates/saves and deletes translations of the given error-message

HTTP method PUT
URI https://api.rambase.net/system/error-messages/{errorMessageId}/translations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {errorMessageId} Error message identifier
Integer, minimum 1000
Successful HTTP status code 200
API resource identifier 197, version 5

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Translations
Translations

This field is optional.

>
2
     <Translation
Translation

This field is optional.

>
3
          <Language
Language

The language of the translated error-message

This field is optional.

>{String}</Language>
4
          <TranslatedMessage
TranslatedMessage

The translated error-message

This field is optional.

>{String}</TranslatedMessage>
5
     </Translation>
6
</Translations>
1
{
2
     "translations
Translations

This field is optional.

": [
3
          {
4
               "language
Language

The language of the translated error-message

This field is optional.

": "{String}",
5
               "translatedMessage
TranslatedMessage

The translated error-message

This field is optional.

": "{String}"
6
          }
7
     ]
8
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100036 HTTP 400 Missing required input parameter: {0}
Error 100021 HTTP 400 The input value {0} has illegal value {1}, please use one of {2}
Error 100620 HTTP 400 Message is required
Error 100037 HTTP 400 Message is required when language is specified
Error 100038 HTTP 400 Invalid language: {0}