Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′ErrorDocumentationGet′ Reference Documentation
Description
The following table displays the documentation for the 'ErrorDocumentationGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves a text message corresponding to an error code defined by VersaCloud |
Español (moderno) |
Obtiene un mensaje de texto correspondiente a un código de error definido por VersaCloud |
Português (Brasil) |
Obtém uma mensagem de texto correspondente a um código de erro definido por VersaCloud |
Parameters
The following table describes all of 'ErrorDocumentationGet''s parameters, in every language available.
ID: 1 - Name: Language
Language: English (United States)
Description: Language to use for the human readable error message
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
ID: 2 - Name: ErrorCode
Language: English (United States)
Description: Error code to convert into a human readable message
Type: errorcode - Min-Max Length: 16-16 - Reentr Key Member: No - Optional: No
ID: 1 - Name: Language
Language: Español (moderno)
Description: Idioma a utilizar para el mensaje de error legible por humanos
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
ID: 2 - Name: ErrorCode
Language: Español (moderno)
Description: Código de error a convertir en mensaje legible por humanos
Type: errorcode - Min-Max Length: 16-16 - Reentr Key Member: No - Optional: No
ID: 1 - Name: Language
Language: Português (Brasil)
Description: Idioma a usar para a mensagem de erro legível por humanos
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
ID: 2 - Name: ErrorCode
Language: Português (Brasil)
Description: Código de erro a converter em mensagem legível por humanos
Type: errorcode - Min-Max Length: 16-16 - Reentr Key Member: No - Optional: No
---
Return Value
'ErrorDocumentationGet' 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 'ErrorDocumentationGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Err0000243 |
English (United States) |
Error code description not available in specified language |
:@Err#Err0000243 |
Español (moderno) |
Descripción del código de error no disponible en el idioma especificado |
:@Err#Err0000243 |
Português (Brasil) |
Descrição do código de erro não disponível no idioma solicitado |
US Patent Requested
