Description

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

Language

Documentation

English (United States)

Retrieves description of a method's purpose

Español (moderno)

Recupera descripción del propósito de un método

Português (Brasil)

Recupera descrição do propósito de um método

Parameters

The following table describes all of 'MethodParameterDocumentationGet''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

solutiontoken

128-128

No

No

3

MethodName

English (United States)

Method name whose parameter's description is being retrieved

method

6-64

No

No

4

ID

English (United States)

Parameter's ID

unsigned

1-2

No

No

5

Language

English (United States)

String containing the language code to use to retrieve the parameter's description

language

6-6

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

solutiontoken

128-128

No

No

3

MethodName

Español (moderno)

Nombre del método para el cual se está buscando la descripción del método

method

6-64

No

No

4

ID

Español (moderno)

ID del parámetro

unsigned

1-2

No

No

5

Language

Español (moderno)

Secuencia de caracteres conteniendo el código de idioma a ser usado para obtener la descripción del parámetro

language

6-6

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

solutiontoken

128-128

No

No

3

MethodName

Português (Brasil)

Nome do método para o qual está obtendo a descrição do parâmetro

method

6-64

No

No

4

ID

Português (Brasil)

ID do parâmetro

unsigned

1-2

No

No

5

Language

Português (Brasil)

Sequencia de caracteres contendo o código de idioma a ser usado para obter a descrição do parâmetro

language

6-6

No

No

Return Value

'MethodParameterDocumentationGet' returns a value of type string (minimum length of returned values is one character characters, while maximum length of returned values is 256 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 'MethodParameterDocumentationGet' 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#Prm0000243

English (United States)

Parameter's description has not been defined in specified language

:@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#Prm0000243

Español (moderno)

Descripción del parámetro no ha sido definido en el idioma indicado

:@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

:@Err#Prm0000243

Português (Brasil)

Descrição do parâmetro não foi definida no idioma especificado

US Patent Requested