Description

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

Language

Documentation

English (United States)

Requests changing if specified method parameter is optional (or not)

Español (moderno)

Pide cambiar si el parámetro especificado del método es opcional (o no)

Português (Brasil)

Solicita modificar se o parâmetro especificado do método é opcional (ou não)

Parameters

The following table describes all of 'MethodParameterOptionalSetAllow''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 responsible developer

operationhandle

48-48

No

No

2

SolutionToken

English (United States)

Valid solution token identifying solution the method corresponds to (must be a master token)

solutiontoken

128-128

Yes

No

3

MethodName

English (United States)

Method name whose parameter' optional status is being modified

method

6-64

Yes

No

4

ID

English (United States)

Parameter's ID

unsigned

1-2

Yes

No

5

Optional

English (United States)

New optional status requested for parameter

boolean

4-5

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al desarrollador responsable

operationhandle

48-48

No

No

2

SolutionToken

Español (moderno)

Token de Solución válido identificando la solución a la cual el método pertenece (tiene que ser un token máster)

solutiontoken

128-128

Yes

No

3

MethodName

Español (moderno)

Nombre del método cuyo parámetro está siendo cambiado de estado de opcional

method

6-64

Yes

No

4

ID

Español (moderno)

ID del parámetro

unsigned

1-2

Yes

No

5

Optional

Español (moderno)

Novo status de opcional del parámetro

boolean

4-5

No

No

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando desenvolvedor responsável

operationhandle

48-48

No

No

2

SolutionToken

Português (Brasil)

Token de Solução válido identificando a solução à qual o método pertence (tem que ser um token master)

solutiontoken

128-128

Yes

No

3

MethodName

Português (Brasil)

Nome do método cujo parâmetro está mudando de status de opcional

method

6-64

Yes

No

4

ID

Português (Brasil)

ID do parâmetro

unsigned

1-2

Yes

No

5

Optional

Português (Brasil)

Novo status de opcional do parâmetro

boolean

4-5

No

No

Return Value

'MethodParameterOptionalSetAllow' 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 'MethodParameterOptionalSetAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

Errorcode

Language

Description

:@Err#Met0000011

English (United States)

Value provided as method name is not part of specified Solution

:@Err#Met0000911

English (United States)

A method's definition cannot be modified while there are active transactions created as instance of this same method

:@Err#Prm0000004

English (United States)

Parameter ID provided has not been defined for this method

:@Err#Sol0000006

English (United States)

Solution Token is not valid

:@Err#Met0000011

Español (moderno)

Valor informado como nombre de método no es parte de la solución indicada

:@Err#Met0000911

Español (moderno)

La definición de un método no puede ser cambiada mientras haya transacciones activas e instanciadas a partir del método en cuestión

:@Err#Prm0000004

Español (moderno)

ID de parámetro indicado no fue definido para este método

:@Err#Sol0000006

Español (moderno)

Token de solución no es válido

:@Err#Met0000011

Português (Brasil)

Valor informado como nome de método não é parte da solução especificada

:@Err#Met0000911

Português (Brasil)

A definição de um método não pode ser modificada enquanto houver transações ativas e instanciadas a partir do método em questão

:@Err#Prm0000004

Português (Brasil)

ID de parâmetro fornecido não foi definido para este método

:@Err#Sol0000006

Português (Brasil)

Token de solução não é válido

US Patent Requested