Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′ErrorAddAllow′ Reference Documentation
Description
The following table displays the documentation for the 'ErrorAddAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests defining a new custom errorcode to be used with a specific solution |
Español (moderno) |
Solicita la definición de un nuevo código de error a ser utilizado con una solución específica |
Português (Brasil) |
Solicita a definição de um nóvo código de erro a ser usado com uma solução específica |
Parameters
The following table describes all of 'ErrorAddAllow''s parameters, in every language available.
ID: 1 - Name: SolutionToken
Language: English (United States)
Description: Solution's master token
Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No
ID: 2 - Name: ErrorCode
Language: English (United States)
Description: String containing the new error code (starting with ':@Err#')
Type: string - Min-Max Length: 16-16 - Reentr Key Member: Yes - Optional: No
ID: 1 - Name: SolutionToken
Language: Español (moderno)
Description: Token máster de la solución
Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No
ID: 2 - Name: ErrorCode
Language: Español (moderno)
Description: Secuencia de caracteres conteniendo el nuevo código de error (empezando con ':@Err#')
Type: string - Min-Max Length: 16-16 - Reentr Key Member: Yes - Optional: No
ID: 1 - Name: SolutionToken
Language: Português (Brasil)
Description: Master token da solução
Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No
ID: 2 - Name: ErrorCode
Language: Português (Brasil)
Description: Sequencia de caracteres contendo o novo código de erro (iniciando em ':@Err#')
Type: string - Min-Max Length: 16-16 - Reentr Key Member: Yes - Optional: No
---
Return Value
'ErrorAddAllow' 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 'ErrorAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Err9999994 |
English (United States) |
Error codes must start with ':@Err#' and have a total length of exactly 16 characters |
:@Err#Err9999996 |
English (United States) |
Error code provided is already in use by specified solution |
:@Err#Sol0000006 |
English (United States) |
Solution Token is not valid |
:@Err#Err9999994 |
Español (moderno) |
Códigos de error deben iniciar en ':@Err#' e tener un largo total de 16 carácteres |
:@Err#Err9999996 |
Español (moderno) |
Código de error indicado ya está en uso por la solución indicada |
:@Err#Sol0000006 |
Español (moderno) |
Token de solución no es válido |
:@Err#Err9999994 |
Português (Brasil) |
Códigos de erro devem iniciar em ':@Err#' e ter um comprimento total de 16 caracteres |
:@Err#Err9999996 |
Português (Brasil) |
Código de erro fornecido já está em uso pela solução especificada |
:@Err#Sol0000006 |
Português (Brasil) |
Token de solução não é válido |
US Patent Requested
