Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'ErrorDocumentationSetAllow' Reference Documentation
Description
The following table displays the documentation for the 'ErrorDocumentationSetAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Request to modify a solution specific error's description |
Español (moderno) |
Solicitud para modificar la descripción de um error específico de una solución |
Português (Brasil) |
Solicitação para modificar a descrição de um erro específico de uma solução |
Parameters
The following table describes all of 'ErrorDocumentationSetAllow''s parameters, in every language available.
ID |
Name |
Language |
Description |
Type |
Min-Max Length |
Reentr Key Member |
Optional |
|---|---|---|---|---|---|---|---|
1 |
Login |
English (United States) |
Operation handle returned from succesful call of UserLoginAllow, identifying user requesting change |
48-48 |
No |
No |
|
2 |
SolutionToken |
English (United States) |
Existing token of specific solution (can be initial master token or a translator token) |
128-128 |
No |
No |
|
3 |
ErrorCode |
English (United States) |
Error code to convert into a human readable message |
16-16 |
Yes |
No |
|
4 |
Language |
English (United States) |
Language to use for the human readable error message |
6-6 |
Yes |
No |
|
5 |
ErrorDocumentation |
English (United States) |
String containing the error's description |
3-256 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario que hace el pedido |
48-48 |
No |
No |
|
2 |
SolutionToken |
Español (moderno) |
Token ya existente de una solución específica (puede ser el token 'principal' inicial o un token de traductor) |
128-128 |
No |
No |
|
3 |
ErrorCode |
Español (moderno) |
Código de error a convertir en mensaje legible por humanos |
16-16 |
Yes |
No |
|
4 |
Language |
Español (moderno) |
Idioma a utilizar para el mensaje de error legible por humanos |
6-6 |
Yes |
No |
|
5 |
ErrorDocumentation |
Español (moderno) |
Secuencia de caracteres conteniendo la descripción del error |
3-256 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando usuário que faz o pedido |
48-48 |
No |
No |
|
2 |
SolutionToken |
Português (Brasil) |
Token já existente de uma solução específica (pode ser o token 'mestre' inicial ou um token de tradutor) |
128-128 |
No |
No |
|
3 |
ErrorCode |
Português (Brasil) |
Código de erro a converter em mensagem legível por humanos |
16-16 |
Yes |
No |
|
4 |
Language |
Português (Brasil) |
Idioma a usar para a mensagem de erro legível por humanos |
6-6 |
Yes |
No |
|
5 |
ErrorDocumentation |
Português (Brasil) |
Sequencia de caracteres contendo a descrição do erro |
3-256 |
No |
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):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Err9999999 |
English (United States) |
Unrecognizable error code |
:@Err#Sol0000008 |
English (United States) |
Solution Token type must be either M ('master') or Q ('query') |
:@Err#Err9999999 |
Español (moderno) |
Código de error no reconocido |
:@Err#Sol0000008 |
Español (moderno) |
Tipo de token de solución tiene que ser M ('master') o Q ('query') |
:@Err#Err9999999 |
Português (Brasil) |
Código de erro não reconhecido |
:@Err#Sol0000008 |
Português (Brasil) |
Tipo de token de solução tem que ser M ('master') ou Q ('query') |
US Patent Requested
