Base APIs
Create a translation of a specific company setting definition.
| HTTP method | POST |
| URI | https://api.rambase.net/base/companies/setting-definitions/{settingDefinitionId}/translations |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {settingDefinitionId} |
Company setting definition identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 2050, version 6 |
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.
Language
Required/mandatory field
Language of the translation
>{String}</Language>Name
Required/mandatory field
Translation of the name
>{String}</Name>Description
Translation of the description
This field is optional.
>{String}</Description>Language
Required/mandatory field
Language of the translation
": "{String}",Name
Required/mandatory field
Translation of the name
": "{String}",Description
Translation of the description
This field is optional.
": "{String}"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. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
TranslationId
Translation identifier
>{Integer}</TranslationId>Language
Language of the translation
Possible domain values can be found here
>{String}</Language>Name
Translation of the name
>{String}</Name>Description
Translation of the description
>{String}</Description>TranslationId
Translation identifier
": "{Integer}",Language
Language of the translation
Possible domain values can be found here
": "{String}",Name
Translation of the name
": "{String}",Description
Translation of the description
": "{String}"
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 101015 HTTP 404 | Permission not found |
| Error 100038 HTTP 400 | Invalid language: {0} |
| Error 101577 HTTP 400 | Description with language {0} already exists |
| Error 101579 HTTP 400 | A translated name is required |