VersaCloud API ′MethodParameterOptionalGet′ Reference Documentation

Description

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

Parameters

The following table describes all of 'MethodParameterOptionalGet''s parameters, in every language available.

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow, identifying responsible developer

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: SolutionToken

Language: English (United States)

Description: Valid solution token identifying solution the method corresponds to

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

ID: 3 - Name: MethodName

Language: English (United States)

Description: Method name whose parameter is being checked for being optional

Type: method - Min-Max Length: 6-64 - Reentr Key Member: No - Optional: No

ID: 4 - Name: ID

Language: English (United States)

Description: Parameter's ID

Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: No

ID: 1 - Name: Login

Language: Español (moderno)

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

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: SolutionToken

Language: Español (moderno)

Description: Token de Solución válido identificando la solución a la cual el método pertenece

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

ID: 3 - Name: MethodName

Language: Español (moderno)

Description: Nombre del método cuyo parámetro está siendo verificado como opcional

Type: method - Min-Max Length: 6-64 - Reentr Key Member: No - Optional: No

ID: 4 - Name: ID

Language: Español (moderno)

Description: ID del parámetro

Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: No

ID: 1 - Name: Login

Language: Português (Brasil)

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

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: SolutionToken

Language: Português (Brasil)

Description: Token de Solução válido identificando a solução à qual o método pertence

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

ID: 3 - Name: MethodName

Language: Português (Brasil)

Description: Nome do método cujo parâmetro está sendo checado como opcional

Type: method - Min-Max Length: 6-64 - Reentr Key Member: No - Optional: No

ID: 4 - Name: ID

Language: Português (Brasil)

Description: ID do parâmetro

Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: 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):

US Patent Requested