Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ utility / languageTranslatePhrase

  • Article
  • 1 minutes to read

Description

This operation takes a phrase in one language and attempts to translate it to another language. This operation uses the Google Translate API which is a chargeable service provided by Google. You need to add a Google Translate API Key through the administration tool before this operation will work. Please note that the underlying Google Translate API does not have support for Language cultures so if specified the culture will be ignored. For example ‘en’, ‘en-GB’ and ‘en-US’ are all treated as ‘en’

API Details

  • Status:
  • The required privilege level to invoke this method is guest
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The languageTranslatePhrase method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
phraseToTranslate xs:string Required The text or phrase to translate
sourceLanguage xs:language Optional The language that the ‘phraseToTranslate’ is in. If not specified and detectSourceLanguage param is set to false then user’s session language is used.
targetLanguage xs:language Optional The language that you would like the source translated to. If not specified then user’s session language is used.
detectSourceLanguage xs:boolean Optional
Default=false		 Set this param to ‘true’ to detect the language of specified phrase. If sourceLanguage param is specified then this params will be ignored.

Response Parameters

Name Type Attributes Description
translatedPhrase xs:string Required The translated text or phrase.
detectedSourceLanguage xs:language Optional The detected source language of specified phrase. This is only returned if detectSourceLanguage param is set to ‘true’
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document