Description

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

Language

Documentation

English (United States)

Requests modification of a method's description in a specific language

Español (moderno)

Pide a la modificación de la descripción de un método en un idioma específico

Português (Brasil)

Solicitações de alteração da descrição de um método em uma linguagem específica

Parameters

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

Existing token of specific solution (can be initial master token or a translator token)

solutiontoken

128-128

Yes

No

3

MethodName

English (United States)

Method name for which the description is being modified

method

6-64

Yes

No

4

Language

English (United States)

Language in which the description is being defined

language

6-6

Yes

No

5

Documentation

English (United States)

String containing the new solution's description

string

1-256

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 ya existente de una solución específica (puede ser el token 'principal' inicial o un token de traductor)

solutiontoken

128-128

Yes

No

3

MethodName

Español (moderno)

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

method

6-64

Yes

No

4

Language

Español (moderno)

Idioma en el cual la descripción está siendo definida

language

6-6

Yes

No

5

Documentation

Español (moderno)

Secuencia de caracteres conteniendo la nueva descripción de la solución

string

1-256

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 já existente de uma solução específica (pode ser o token 'mestre' inicial ou um token de tradutor)

solutiontoken

128-128

Yes

No

3

MethodName

Português (Brasil)

Nome do método para o qual a descrição está sendo modificada

method

6-64

Yes

No

4

Language

Português (Brasil)

Idioma no qual a descrição está sendo definida

language

6-6

Yes

No

5

Documentation

Português (Brasil)

Sequencia de caracteres contendo a nova descrição da solução

string

1-256

No

No

Return Value

'MethodDocumentationSetAllow' 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 'MethodDocumentationSetAllow' 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#Sol0000017

English (United States)

Solution Token type must be either M ('master') or T ('translator)

:@Err#Met0000011

Español (moderno)

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

:@Err#Sol0000017

Español (moderno)

Tipo de token de solución tiene que ser M ('master') o T ('traductor')

:@Err#Met0000011

Português (Brasil)

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

:@Err#Sol0000017

Português (Brasil)

Tipo de token de solução tem que ser M ('master') ou T ('tradutor')

US Patent Requested