Description

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

Language

Documentation

English (United States)

Retrieves a short description of a method's purpose

Español (moderno)

Obtiene uma breve descripción del propósito de un método

Português (Brasil)

Obtêm uma breve descrição do objetivo do método

Parameters

The following table describes all of 'MethodDocumentationGet''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 description is being requested

method

6-64

No

No

4

Language

English (United States)

Language the description should be retrieved in

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

method

6-64

No

No

4

Language

Español (moderno)

Idioma en el cual la descripción debe ser obtenida

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 a descrição está sendo obtida

method

6-64

No

No

4

Language

Português (Brasil)

Idioma no qual a descrição deve ser obtida

language

6-6

No

No

Return Value

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

Errorcode

Language

Description

:@Err#Doc0000243

English (United States)

Requested documentation is not available in specified language

:@Err#Met0000011

English (United States)

Value provided as method name is not part of specified Solution

:@Err#Doc0000243

Español (moderno)

Documentación requerida no está disponible en el idioma solicitado

:@Err#Met0000011

Español (moderno)

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

:@Err#Doc0000243

Português (Brasil)

Documentação solicitada não está disponível no idioma especificado

:@Err#Met0000011

Português (Brasil)

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

US Patent Requested