VersaCloud API ′ErrorDocumentationSetAllow′ Reference Documentation

Description

The following table displays the documentation for the 'ErrorDocumentationSetAllow' API in all languages currently available:

Parameters

The following table describes all of 'ErrorDocumentationSetAllow''s parameters, in every language available.

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow, identifying user requesting change

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: SolutionToken

Language: English (United States)

Description: Existing token of specific solution (can be initial master token or a translator token)

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

ID: 3 - 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: Yes - Optional: No

ID: 4 - 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: Yes - Optional: No

ID: 5 - Name: ErrorDocumentation

Language: English (United States)

Description: String containing the error's description

Type: string - Min-Max Length: 3-256 - Reentr Key Member: No - Optional: No

ID: 1 - Name: Login

Language: Español (moderno)

Description: Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario que hace el pedido

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: SolutionToken

Language: Español (moderno)

Description: Token ya existente de una solución específica (puede ser el token 'principal' inicial o un token de traductor)

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

ID: 3 - 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: Yes - Optional: No

ID: 4 - 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: Yes - Optional: No

ID: 5 - Name: ErrorDocumentation

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo la descripción del error

Type: string - Min-Max Length: 3-256 - Reentr Key Member: No - Optional: No

ID: 1 - Name: Login

Language: Português (Brasil)

Description: Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando usuário que faz o pedido

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: SolutionToken

Language: Português (Brasil)

Description: Token já existente de uma solução específica (pode ser o token 'mestre' inicial ou um token de tradutor)

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

ID: 3 - 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: Yes - Optional: No

ID: 4 - 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: Yes - Optional: No

ID: 5 - Name: ErrorDocumentation

Language: Português (Brasil)

Description: Sequencia de caracteres contendo a descrição do erro

Type: string - Min-Max Length: 3-256 - Reentr Key Member: No - Optional: No

---

Return Value

'ErrorDocumentationSetAllow' returns a value of type operationHandle (minimum length of returned values is 48 characters characters, while maximum length of returned values is 48 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 'ErrorDocumentationSetAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

US Patent Requested