API

Production APIs

POST production/mrb-specifications/{mrbSpecificationId}/sections/{sectionId}/translations

Creates a new translated section title

HTTP method POST
URI https://api.rambase.net/production/mrb-specifications/{mrbSpecificationId}/sections/{sectionId}/translations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {mrbSpecificationId} MRB specification identifier
Integer, minimum 100000
- URI parameter {sectionId} Book section identifier
Integer, minimum 1
Successful HTTP status code 201
API resource identifier 5569, version 2

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
     <Title
Title

Required/mandatory field

Translated section title

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

Required/mandatory field

Translated language

Applicable domain values can be found here

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

Required/mandatory field

Translated section title

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

Required/mandatory field

Translated language

Applicable domain values can be found here

":
"{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

Unique identifier for a translated section title

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

Translated section title

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

Translated language

Possible domain values can be found here

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

Date and time when the title was translated

>
{Datetime}</CreatedAt>
6
</Translation>
1
{
2
     "translation": {
3
          "translationId
TranslationId

Unique identifier for a translated section title

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

Translated section title

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

Translated language

Possible domain values can be found here

":
"{String}",
6
          "createdAt
CreatedAt

Date and time when the title was translated

":
"{Datetime}"
7
     }
8
}

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 107716 HTTP 400 No language provided for the translation
Error 107717 HTTP 400 Translated title is empty