Language translations

>>>

GET /api/v1/language_translations
List language translations.

List language translations in the user’s account.

Examples

{
  "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 /api/v1/language_translation/:id
Get the details for a language translation.

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.

Examples

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

Params

Param name Description
id
optional

The Language Translation ID.

Validations:

  • Must be a Integer
name
optional

The URI encoded name of the Language Translation, including .ini file extension.

Validations:

  • Must be a String
>>>

POST /api/v1/language_translations
Create a new language translation.

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

Params

Param name Description
language_translation["description"]
required

The description of the language file

Validations:

  • Must be a String
language_translation["file_input"]
optional

The file to upload when using multipart/form-data content type.

Validations:

  • Must be a File
>>>

PUT /api/v1/language_translations
Update an existing language translation.

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

Params

Param name Description
id
required

The Language Translation ID

Validations:

  • Must be a String
language_translation["description"]
required

The description of the language file

Validations:

  • Must be a String
language_translation["file_input"]
optional

The file to upload when using multipart/form-data content type.

Validations:

  • Must be a File
>>>

DELETE /api/v1/language_translations/:id
Remove a language translation.

Remove a language translation.

Params

Param name Description
id
required

The Language Translation ID

Validations:

  • Must be a String
>>>

GET /api/v1/language_translations/:id/download
Download the file contents of a language translation.

Download the file contents of a language translation.

Params

Param name Description
id
required

The Language Translation ID

Validations:

  • Must be a String
>>>

POST /api/v1/language_translations/:language_translation_id/devices/link
Link a language translation to one or more devices.

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.

Examples

{
  "status": "success",
  "message": "success",
  "result": [
      DEVICE_ID_1,
      DEVICE_ID_2
  ]
}

Params

Param name Description
language_translation_id
required

The Project ID of the project.

Validations:

  • Must be a Integer
device_id
optional

The Device ID of the device(s).

Validations:

  • Must be a Integer
unit_id
optional

The Unit ID of the device(s).

Validations:

  • Must be a Integer
>>>

POST /api/v1/language_translations/:language_translation_id/devices/link_all
Link a language translation to all devices.

Link a language translation to all devices.

Examples

{
  "status": "success",
  "message": "success",
  "result": [
      DEVICE_ID_1,
      DEVICE_ID_2
  ]
}

Params

Param name Description
language_translation_id
required

The Language Translation ID.

Validations:

  • Must be a Integer
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:

  • Must be a String
>>>

POST /api/v1/language_translations/:language_translation_id/devices/unlink
Unlink a language translation from one or more devices.

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.

Examples

{
  "status": "success",
  "message": "success",
  "result": [
      DEVICE_ID_1,
      DEVICE_ID_2
  ]
}

Params

Param name Description
project_id
required

The ID of the language translation.

Validations:

  • Must be a Integer
device_id
optional

The Device ID of the device(s).

Validations:

  • Must be a Integer
unit_id
optional

The Unit ID of the device(s).

Validations:

  • Must be a Integer
>>>

POST /api/v1/language_translations/:language_translation_id/devices/unlink_all
Unlink a language translation from all devices.

Unlink all devices from a language translation.

Examples

{
  "status": "success",
  "message": "success",
  "result": [
      DEVICE_ID_1,
      DEVICE_ID_2
  ]
}

Params

Param name Description
language_translation_id
required

The Language Translation ID.

Validations:

  • Must be a Integer
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:

  • Must be a String