Translations

Search Translations

This endpoint is used to search through the translations table; the phrase property will do a partial match on the default culture phrase, and filter translations by culture if provided. If start is included limit must also be provided.

Parameter	Value
End Point	`https://<US: api-us.kurtosys.app OR UK: api-uk.kurtosys.app>/config/searchTranslations`
Headers	`X-KSYS-TOKEN`
Content Type	`application/json`
HTTP Method	`POST`

Request

{
    "phrase": "bond",
    "start": 0,
    "limit": 20,
    "cultures": ["en-GB", "it-IT"]
}

Parameter	Required
phrase	false
start	false
limit	false
cultures	false

Response

{
    "start": 0,
    "total": 3,
    "values": [
        {
            "phrase": "Bond Quality Breakdown",
            "translations": [
                {
                    "translation": "Répartition de la qualité des obligations",
                    "translationCulture": "fr-FR"
                },
                {
                    "translation": "Ripartizione della qualità dell'obbligazione",
                    "translationCulture": "it-IT"
                },
                {
                    "translation": "Bond Aufteilung nach Rating",
                    "translationCulture": "de-DE"
                }
            ]
        },
        {
            "phrase": "Bonds",
            "translations": []
        },
        {
            "phrase": "Kurtosys Bond Fund",
            "translations": []
        }
    ]
}

Upsert Translations

Translations are used in the /searchEntity service to convert text into other languages. They can also be used to provide a dictionary of terms to be used in translating on-screen labels. To add new translations, provide a message that converts the original language phrase to the target language phrase. It is important that the phrase is exact and that it targets a common culture set that is used across the client data set.

Service call details

Parameter	Value
End Points	`https://<US: api-us.kurtosys.app OR UK: api-uk.kurtosys.app>/config/upsertTranslation`
	`https://<US: api-us.kurtosys.app OR UK: api-uk.kurtosys.app>/config/upsertTranslations`

Headers	`X-KSYS-TOKEN, X-KSYS-API`
Content Type	`application/json`
HTTP Method	`POST`
Return Type	`JSON`
Return Data	The inserted record or `OK`

Request

For insert

{
    "culture": "en-GB",
    "phrase": "Test",
    "translation": "Tester",
    "translationCulture": "fr-FR"
}

or for an update

[
    {
        "culture": "en-GB",
        "phrase": "Test",
        "translation": "Tester",
        "translationCulture": "fr-FR"
    }
]

Property	Required	TYPE	Description
culture	TRUE	STRING	The culture of the translation phrase
phrase	TRUE	STRING	The translation phrase to compare against
translation	TRUE	STRING	The translation value that will be updated
translationCulture	TRUE	STRING	The culture of the translation value that will be updated

Response

Results will look like:

for insert

{
    "clientId": 2,
    "created": "2019-03-13T09:15:16.000Z",
    "createdBy": 3,
    "culture": "en-GB",
    "lastModified": "2019-03-13T09:15:16.000Z",
    "lastModifiedBy": 3,
    "phrase": "Test",
    "rowHash": "3ddbd7aa91146d92eb82b34a2e782c682002d986bd2436e5166e66487588aff8",
    "translation": "Tester",
    "translationCulture": "fr-FR",
    "translationId": 3941
}

or for an update

"OK"

Delete Translations

This endpoint is used to delete a single or multiple translations where the default translation phrase and target culture are provided.

Service call details

Parameter	Value
End Points	`https://<US: api-us.kurtosys.app OR UK: api-uk.kurtosys.app>/config/deleteTranslations`

Headers	`X-KSYS-TOKEN, X-KSYS-API`
Content Type	`application/json`
HTTP Method	`POST`
Return Type	`JSON`
Return Data	`OK`

Request

[
    {
        "translationCultures": ["de-DE", "ja-JP"],
        "phrases": ["Manager"]
    },
    {
        "translationCultures": ["fr-FR"],
        "phrases": ["Fundlist", "Auditor"]
    },
    {
        "translationCultures": ["en-GB"],
        "phrases": ["Sector Funds"]
    }
]

Property	Required	TYPE	Description
translationCultures	TRUE	STRING ARRAY	The target culture
phrases	TRUE	STRING ARRAY	The default phrase

Response

{ "message": "OK" }

List Translations

This endpoint is used to list the translations table based on the client; client lookup is done on the user token. The culture and translationCulture properties will filter the results.

Parameter	Value
End Point	`https://<US: api-us.kurtosys.app OR UK: api-uk.kurtosys.app>/config/listtranslations`
Headers	`X-KSYS-TOKEN`
Content Type	`application/json`
HTTP Method	`POST`

Request

{
    "culture": "en-GB",
    "translationCulture": ["fr-FR", "it-IT"]
}

Parameter	Required
culture	false
translationCulture	false

Response

[
    {
        "phrase": "$1bh - $5bn",
        "culture": "en-GB",
        "translation": "USD 1 – 5 mld",
        "translationCulture": "it-IT",
        "lastModified": "2019-08-30T05:50:41.000Z",
        "lastModifiedBy": 1001,
        "created": "2019-08-30T05:50:41.000Z",
        "createdBy": 1001
    }
]