API

System APIs

POST system/applications/combined-translations

Returns all translations for the posted applications

HTTP method POST
URI https://api.rambase.net/system/applications/combined-translations
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 200
API resource identifier 2652, version 8

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
<ApplicationVersions>
2
     <ApplicationVersion>
3
          <Checksum
Checksum

Required/mandatory field

The calculated checksum of the sourcecode of this application

>
{String}</Checksum>
4
          <Application>
5
               <ApplicationId
ApplicationId

Required/mandatory field

Application Identifier

>
{Integer}</ApplicationId>
6
          </Application>
7
     </ApplicationVersion>
8
</ApplicationVersions>
1
{
2
     "applicationVersions": [
3
          {
4
               "checksum
Checksum

Required/mandatory field

The calculated checksum of the sourcecode of this application

":
"{String}",
5
               "application": {
6
                    "applicationId
ApplicationId

Required/mandatory field

Application Identifier

":
"{Integer}"
7
               }
8
          }
9
     ]
10
}

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.

Language String {OBJECT.LANGUAGE}.

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

Language String {OBJECT.LANGUAGE}

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
<Translations>
2
     <Translation>
3
          <TranslationId
TranslationId

Text template translation identifier

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

Three character code following the ISO 639-2 standard.

Possible domain values can be found here

>
{String}</Language>
5
          <Text
Text

Translated text of a text template

>
{String}</Text>
6
          <TextTemplate>
7
               <TextTemplateId
TextTemplateId

Text template identifier

>
{String}</TextTemplateId>
8
               <Text
Text

Text of text template

>
{String}</Text>
9
               <TextTemplateLink
TextTemplateLink

Text template reference

>
{String}</TextTemplateLink>
10
          </TextTemplate>
11
          <TranslationLink
TranslationLink

Text template translation reference

>
{String}</TranslationLink>
12
     </Translation>
13
</Translations>
1
{
2
     "translations": [
3
          {
4
               "translationId
TranslationId

Text template translation identifier

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

Three character code following the ISO 639-2 standard.

Possible domain values can be found here

":
"{String}",
6
               "text
Text

Translated text of a text template

":
"{String}",
7
               "textTemplate": {
8
                    "textTemplateId
TextTemplateId

Text template identifier

":
"{String}",
9
                    "text
Text

Text of text template

":
"{String}",
10
                    "textTemplateLink
TextTemplateLink

Text template reference

":
"{String}"
11
               },
12
               "translationLink
TranslationLink

Text template translation reference

":
"{String}"
13
          }
14
     ]
15
}

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: