Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'MethodParameterOptionalGet' Reference Documentation
Description
The following table displays the documentation for the 'MethodParameterOptionalGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Indicates if specified method parameter is optional (or not) |
Español (moderno) |
Indica si el parámetro especificado del método es opcional (o no) |
Português (Brasil) |
Indica se o parâmetro especificado do método é opcional (ou não) |
Parameters
The following table describes all of 'MethodParameterOptionalGet''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 |
48-48 |
No |
No |
|
2 |
SolutionToken |
English (United States) |
Valid solution token identifying solution the method corresponds to |
128-128 |
No |
No |
|
3 |
MethodName |
English (United States) |
Method name whose parameter is being checked for being optional |
6-64 |
No |
No |
|
4 |
ID |
English (United States) |
Parameter's ID |
1-2 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al desarrollador responsable |
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 |
128-128 |
No |
No |
|
3 |
MethodName |
Español (moderno) |
Nombre del método cuyo parámetro está siendo verificado como opcional |
6-64 |
No |
No |
|
4 |
ID |
Español (moderno) |
ID del parámetro |
1-2 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando desenvolvedor responsável |
48-48 |
No |
No |
|
2 |
SolutionToken |
Português (Brasil) |
Token de Solução válido identificando a solução à qual o método pertence |
128-128 |
No |
No |
|
3 |
MethodName |
Português (Brasil) |
Nome do método cujo parâmetro está sendo checado como opcional |
6-64 |
No |
No |
|
4 |
ID |
Português (Brasil) |
ID do parâmetro |
1-2 |
No |
No |
Return Value
'MethodParameterOptionalGet' returns a value of type boolean (minimum length of returned values is 4 characters characters, while maximum length of returned values is 5 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 'MethodParameterOptionalGet' 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#Prm0000004 |
English (United States) |
Parameter ID provided has not been defined for this method |
:@Err#Met0000011 |
Español (moderno) |
Valor informado como nombre de método no es parte de la solución indicada |
:@Err#Prm0000004 |
Español (moderno) |
ID de parámetro indicado no fue definido para este método |
:@Err#Met0000011 |
Português (Brasil) |
Valor informado como nome de método não é parte da solução especificada |
:@Err#Prm0000004 |
Português (Brasil) |
ID de parâmetro fornecido não foi definido para este método |
US Patent Requested
