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

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

Language

English (United States)

Language to use for the human readable error message

language

6-6

No

No

2

ErrorCode

English (United States)

Error code to convert into a human readable message

errorcode

16-16

No

No

1

Language

Español (moderno)

Idioma a utilizar para el mensaje de error legible por humanos

language

6-6

No

No

2

ErrorCode

Español (moderno)

Código de error a convertir en mensaje legible por humanos

errorcode

16-16

No

No

1

Language

Português (Brasil)

Idioma a usar para a mensagem de erro legível por humanos

language

6-6

No

No

2

ErrorCode

Português (Brasil)

Código de erro a converter em mensagem legível por humanos

errorcode

16-16

No

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