Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'TypeLocalizedValueGet' Reference Documentation
Description
The following table displays the documentation for the 'TypeLocalizedValueGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves a specific type's value in a specific language (applies to limited types) |
Español (moderno) |
Recupera un valor de un tipo específico en un idioma específico (aplicable sólo a algunos tipos) |
Português (Brasil) |
Recupera um valor de um tipo específico em um idioma específico (aplicável apenas a alguns tipos) |
Parameters
The following table describes all of 'TypeLocalizedValueGet''s parameters, in every language available.
ID |
Name |
Language |
Description |
Type |
Min-Max Length |
Reentr Key Member |
Optional |
|---|---|---|---|---|---|---|---|
1 |
TypeName |
English (United States) |
String containing the type name to have one localized value retrieved |
3-24 |
No |
No |
|
2 |
Value |
English (United States) |
Specific value to have its localized version retrieved (can be another localized value) |
1-232 |
No |
No |
|
3 |
LanguageCode |
English (United States) |
Specific human language to be used to retrieve the localized value |
6-6 |
No |
No |
|
1 |
TypeName |
Español (moderno) |
Secuencia de caracteres conteniendo el nombre del tipo conteniendo el valor cuya traducción desea obtener |
3-24 |
No |
No |
|
2 |
Value |
Español (moderno) |
Valor específico cuya versión en otro idioma se desea obtener (puede ser el valor en cualquier idioma) |
1-232 |
No |
No |
|
3 |
LanguageCode |
Español (moderno) |
Idioma a ser utilizado para obtener el nombre del valor traducido |
6-6 |
No |
No |
|
1 |
TypeName |
Português (Brasil) |
Sequencia de caracteres contendo o nome do tipo contendo o valor cuja tradução deseja obter |
3-24 |
No |
No |
|
2 |
Value |
Português (Brasil) |
Valor específico cuja versão em outro idioma se deseja obter (pode ser o valor em qualquer idioma) |
1-232 |
No |
No |
|
3 |
LanguageCode |
Português (Brasil) |
Idioma a ser usado para obter o nome traduzido do valor |
6-6 |
No |
No |
Return Value
'TypeLocalizedValueGet' returns a value of type string (minimum length of returned values is one character characters, while maximum length of returned values is 232 characters characters).
Please note that all APIs returning values of types that allow for localized values (like e.g. boolean or country) always return the standard type values.
Specific Error Codes
If an error happens during the execution of any VersaCloud call, an errorcode is returned instead of the standard return value described above.
The following table lists errorcodes returned specifically by the 'TypeLocalizedValueGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Typ0000003 |
English (United States) |
This type's values are not fixed and translatable |
:@Err#Typ0000004 |
English (United States) |
This value is not part of allowed values of specified type |
:@Err#Typ0000245 |
English (United States) |
This value's localized version is not available in the requested language |
:@Err#Typ0000003 |
Español (moderno) |
Los valores de este tipo no son fijos y traducibles |
:@Err#Typ0000004 |
Español (moderno) |
Este valor no es parte de los valores permitidos para este tipo |
:@Err#Typ0000245 |
Español (moderno) |
La descripción de este valor no está disponible en el idioma especificado |
:@Err#Typ0000003 |
Português (Brasil) |
Os valores deste tipo não são fixos e traduzíveis |
:@Err#Typ0000004 |
Português (Brasil) |
Este valor não é parte dos valores permitidos para este tipo |
:@Err#Typ0000245 |
Português (Brasil) |
A descrição deste valor não está disponível no idioma solicitado |
US Patent Requested
