Material Translations

Get material_translations

get

/material_translations/

This api is used to sync translations for material with WorkorderApp. Each material translation record contains the following data:

Parameter	Description	Type (size)
reference_key	Unique code (material code in OutSmart)	Varchar (30)
original	Original name of the material	Text (max length: 64kB)
translation	Translated description for the material	Text (max length: 64kB)
language	Lowercase code which represents the language of the translation	Varchar (5)

Language	Code
English	en
German	de
Dutch	nl
Portugese	pt
French	fr
Spanish	es
Portugese - Brasil	pt-br

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

Responses

200

Response_200

application/json

codeintegerOptional

messagesarrayOptional

get/material_translations/

GET /material_translations/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response_200

{
  "code": 200,
  "messages": [],
  "response": [
    {
      "id": "3",
      "reference_key": "NL2002",
      "original": "LED Lamp",
      "translation": "LED Light",
      "language": "EN"
    },
    {
      "id": "4",
      "reference_key": "NL2004",
      "original": "Deurbel",
      "translation": "Doorbell",
      "language": "EN"
    }
  ]
}

Add material_translations

post

/material_translations/

This api is used to sync translations for material with WorkorderApp. Each material translation record can contain the following data:

Parameter	Description	Required	Type (size)
reference_key	Unique code (material code in OutSmart)	Y	Varchar (30)
original	Original name of the material	Y	Text (max length: 64kB)
translation	Translated description for the material	Y	Text (max length: 64kB)
language	Lowercase code which represents the language of the translation	Y	Varchar (5)

Language	Code
English	en
German	de
Dutch	nl
Portugese	pt
French	fr
Spanish	es
Portugese - Brasil	pt-br

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

Responses

200

Response_200

application/json

codeintegerOptional

messagesarrayOptional

responseintegerOptional

post/material_translations/

POST /material_translations/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response_200

{
  "code": 200,
  "messages": [],
  "response": 4
}

Delete material_translations by id

delete

/material_translations/

This api is used to delete translations for materials within OutSmart.

Deleting translations can also be done by providing the material code and language code.

Records can be deleted by providing a list of ids which can be retrieved through "GET material_translations".

Parameter	Description	Required	Type (size)
ids	A list of ids to be deleted	Y	array

Supported from OutSmart Backoffice v6.0.0

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

Responses

200

Response_200

application/json

codeintegerOptional

messagesstring · style[]Optional

responsenullOptional

delete/material_translations/

DELETE /material_translations/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response_200

{
  "code": 200,
  "messages": [
    "Rows deleted: 3"
  ],
  "response": null
}