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

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

SolutionToken

English (United States)

Solution's master token

solutiontoken

128-128

No

No

2

ErrorCode

English (United States)

String containing the new error code (starting with ':@Err#')

string

16-16

Yes

No

1

SolutionToken

Español (moderno)

Token máster de la solución

solutiontoken

128-128

No

No

2

ErrorCode

Español (moderno)

Secuencia de caracteres conteniendo el nuevo código de error (empezando con ':@Err#')

string

16-16

Yes

No

1

SolutionToken

Português (Brasil)

Master token da solução

solutiontoken

128-128

No

No

2

ErrorCode

Português (Brasil)

Sequencia de caracteres contendo o novo código de erro (iniciando em ':@Err#')

string

16-16

Yes

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