API

System APIs

POST system/rambase-menu-items/{RamBaseMenuItemId}/translations

Post translation for rambase menu item

HTTP method POST
URI https://api.rambase.net/system/rambase-menu-items/{RamBaseMenuItemId}/translations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {RamBaseMenuItemId} A unique RamBase menu item id.
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 3393, version 3

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
<Translation>
2
     <Language
Language

Required/mandatory field

Unique language of the translation. Three character code following the ISO 639-2 standard.

Applicable domain values can be found here

>{String}</Language>
3
     <Title
Title

Required/mandatory field

This is the same as the title field, except from the title being translated into the current user preffered language. If a translation in that language does not exist, the english title will be returned.

>{String}</Title>
4
</Translation>
1
{
2
     "translation": {
3
          "language
Language

Required/mandatory field

Unique language of the translation. Three character code following the ISO 639-2 standard.

Applicable domain values can be found here

": "{String}",
4
          "title
Title

Required/mandatory field

This is the same as the title field, except from the title being translated into the current user preffered language. If a translation in that language does not exist, the english title will be returned.

": "{String}"
5
     }
6
}

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.

Format:
1
<Translation>
2
     <TranslationId
TranslationId

Translation identifier

>{Integer}</TranslationId>
3
     <Language
Language

Unique language of the translation. Three character code following the ISO 639-2 standard.

Possible domain values can be found here

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

This is the same as the title field, except from the title being translated into the current user preffered language. If a translation in that language does not exist, the english title will be returned.

>{String}</Title>
5
</Translation>
1
{
2
     "translation": {
3
          "translationId
TranslationId

Translation identifier

": "{Integer}",
4
          "language
Language

Unique language of the translation. Three character code following the ISO 639-2 standard.

Possible domain values can be found here

": "{String}",
5
          "title
Title

This is the same as the title field, except from the title being translated into the current user preffered language. If a translation in that language does not exist, the english title will be returned.

": "{String}"
6
     }
7
}

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 101868 HTTP 400 Language is required
Error 101869 HTTP 400 Translated title is required
Error 101873 HTTP 400 There is already a translation in this language
Error 100038 HTTP 400 Invalid language: {0}