List language translations in the user’s account.
{
"status" : "success",
"message": "success",
"result" : [
{
"id"=> 1,
"name"=> "CustomLanguage.ini",
"description"=>"Custom description",
"checksum"=>1582586769,
"created_at"=>"2020-03-02T22:24:27.000Z",
"updated_at"=>"2020-03-02T22:24:27.000Z"
},
{
"id"=> 2,
"name"=> "CustomLanguage2.ini",
"description"=>"Custom description",
"checksum"=>1582586770,
"created_at"=>"2020-02-24T22:14:47.000Z",
"updated_at"=>"2020-02-24T22:14:47.000Z"
},
]
}
Get the details for a language translation using a specified language translation ID or using the file name (including .ini extension). The ID and name of a language translation can be found in the language translation list.
{
"status": "success",
"message": "success",
"result": {
"id"=> 1,
"name"=> "CustomLanguage.ini",
"description"=>"Custom description",
"checksum"=>1582586769,
"created_at"=>"2020-03-02T22:24:27.000Z",
"updated_at"=>"2020-03-02T22:24:27.000Z"
}
}
| Param name | Description |
|---|---|
|
id optional |
The Language Translation ID. Validations:
|
|
name optional |
The URI encoded name of the Language Translation, including .ini file extension. Validations:
|
Creates a new language translation for this account.
Accepted content-types: * multipart/form-data * application/octet-stream
Example multipart/form-data request:
{
"language_translation" : {
"description" : "custom description",
"file_input" : file attachment
}
}NOTE: The filename will be extracted from the attached file and must be a valid .ini file.
Example application/octet-stream request:
{
"language_translation":{
"name" : "CustomLanguage.ini"
"description" : "custom description"
}
}NOTE: The file to upload will be extracted from the raw POST request.
An example successful response:
{
"status": "success",
"message": "success",
"result": {
"id"=>134,
"name"=>"CustomLanguage.ini",
"description"=>"custom description",
"checksum"=>1583191961,
"created_at"=>Mon, 02 Mar 2020 23:32:41 UTC +00:00,
"updated_at"=>Mon, 02 Mar 2020 23:32:41 UTC +00:00
}
}| Param name | Description |
|---|---|
|
language_translation["description"] required |
The description of the language file Validations:
|
|
language_translation["file_input"] optional |
The file to upload when using multipart/form-data content type. Validations:
|
Updates an existing language translation.
Accepted content-types: * multipart/form-data * application/octet-stream
Example multipart/form-data request:
{
"id" : 134,
"language_translation" : {
"description" : "custom description",
"file_input" : file attachment
}
}NOTE: The filename will be extracted from the attached file and must be a valid .ini file.
Example application/octet-stream request:
{
"id" : 134,
"language_translation":{
"name" : "CustomLanguage.ini"
"description" : "custom description"
}
}NOTE: The file to upload will be extracted from the raw POST request.
An example successful response:
{
"status": "success",
"message": "success",
"result": {
"id"=>134,
"name"=>"CustomLanguage.ini",
"description"=>"custom description",
"checksum"=>1583191961,
"created_at"=>Mon, 02 Mar 2020 23:32:41 UTC +00:00,
"updated_at"=>Mon, 02 Mar 2020 23:32:41 UTC +00:00
}
}| Param name | Description |
|---|---|
|
id required |
The Language Translation ID Validations:
|
|
language_translation["description"] required |
The description of the language file Validations:
|
|
language_translation["file_input"] optional |
The file to upload when using multipart/form-data content type. Validations:
|
Remove a language translation.
| Param name | Description |
|---|---|
|
id required |
The Language Translation ID Validations:
|
Download the file contents of a language translation.
| Param name | Description |
|---|---|
|
id required |
The Language Translation ID Validations:
|
Link a language translation to one or more devices.
The device_id parameter can be: * a Device ID. * an array of Device IDs.
OR
The unit_id parameter can be: * a Unit ID. * an array of Unit IDs.
{
"status": "success",
"message": "success",
"result": [
DEVICE_ID_1,
DEVICE_ID_2
]
}
| Param name | Description |
|---|---|
|
language_translation_id required |
The Project ID of the project. Validations:
|
|
device_id optional |
The Device ID of the device(s). Validations:
|
|
unit_id optional |
The Unit ID of the device(s). Validations:
|
Link a language translation to all devices.
{
"status": "success",
"message": "success",
"result": [
DEVICE_ID_1,
DEVICE_ID_2
]
}
| Param name | Description |
|---|---|
|
language_translation_id required |
The Language Translation ID. Validations:
|
|
response_type optional |
By default, the request will return an array of Device IDs. If response_type parameter is set to ‘unit_ids’ the request will return an array of Device Unit IDs instead. Validations:
|
Link a language translation to one or more devices.
The device_id parameter can be: * a Device ID. * an array of Device IDs.
OR
The unit_id parameter can be: * a Unit ID. * an array of Unit IDs.
{
"status": "success",
"message": "success",
"result": [
DEVICE_ID_1,
DEVICE_ID_2
]
}
| Param name | Description |
|---|---|
|
project_id required |
The ID of the language translation. Validations:
|
|
device_id optional |
The Device ID of the device(s). Validations:
|
|
unit_id optional |
The Unit ID of the device(s). Validations:
|
Unlink all devices from a language translation.
{
"status": "success",
"message": "success",
"result": [
DEVICE_ID_1,
DEVICE_ID_2
]
}
| Param name | Description |
|---|---|
|
language_translation_id required |
The Language Translation ID. Validations:
|
|
response_type optional |
By default, the request will return an array of Device IDs. If response_type parameter is set to ‘unit_ids’ the request will return an array of Device Unit IDs instead. Validations:
|