API

System APIs

PUT system/duties/{dutyId}/translations/{translationId}

Make a translation for a duty.

HTTP method PUT
URI https://api.rambase.net/system/duties/{dutyId}/translations/{translationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {dutyId} Duty identifier
Integer, minimum 100000
- URI parameter {translationId} Translation identifier.
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 2430, 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
Translation

This field is optional.

>
2
     <Language
Language

Translation language.

Applicable domain values can be found here

This field is optional.

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

Translated name.

This field is optional.

>
{String}</Name>
4
     <Description
Description

Translated description.

This field is optional.

>
{String}</Description>
5
</Translation>
1
{
2
     "translation
Translation

This field is optional.

":
{
3
          "language
Language

Translation language.

Applicable domain values can be found here

This field is optional.

":
"{String}",
4
          "name
Name

Translated name.

This field is optional.

":
"{String}",
5
          "description
Description

Translated description.

This field is optional.

":
"{String}"
6
     }
7
}

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 108705 HTTP 400 Only Department manager is allowed to edit this duty
Error 100038 HTTP 400 Invalid language: {0}
Error 102642 HTTP 400 A translation already exists for the chosen language.
Error 102643 HTTP 400 Translated name required.