Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′TypeDocumentationGet′ Reference Documentation
Description
The following table displays the documentation for the 'TypeDocumentationGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves a specific type's description in a specific language |
Español (moderno) |
Recupera la descripción de un tipo específico en un idioma específico |
Português (Brasil) |
Recupera a descrição de um tipo específico em um idioma específico |
Parameters
The following table describes all of 'TypeDocumentationGet''s parameters, in every language available.
ID: 1 - Name: TypeName
Language: English (United States)
Description: String containing the type name to have its description retrieved
Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No
ID: 2 - Name: LanguageCode
Language: English (United States)
Description: Language to be used to retrieve the type's description
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
ID: 1 - Name: TypeName
Language: Español (moderno)
Description: Secuencia de caracteres conteniendo el nombre del tipo cuya descripción desea obtener
Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No
ID: 2 - Name: LanguageCode
Language: Español (moderno)
Description: Idioma a ser utilizado para obtener la descripción del tipo
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
ID: 1 - Name: TypeName
Language: Português (Brasil)
Description: Sequencia de caracteres contendo o nome do tipo cuja descrição deseja obter
Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No
ID: 2 - Name: LanguageCode
Language: Português (Brasil)
Description: Idioma a ser usado para obter a descrição do tipo
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
---
Return Value
'TypeDocumentationGet' returns a value of type string (minimum length of returned values is 3 characters characters, while maximum length of returned values is 256 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 'TypeDocumentationGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Typ0000243 |
English (United States) |
Type description is not available in the requested language |
:@Err#Typ0000243 |
Español (moderno) |
La descripción del tipo no está disponible en el idioma especificado |
:@Err#Typ0000243 |
Português (Brasil) |
A descrição do tipo não está disponível no idioma solicitado |
US Patent Requested
