VersaCloud API ′MethodParameterDocumentationSetAllow′ Reference Documentation

Description

The following table displays the documentation for the 'MethodParameterDocumentationSetAllow' 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 'MethodParameterDocumentationSetAllow''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: Existing token of specific solution (can be initial master token or a translator token)

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

 

ID: 3 - Name: MethodName

Language: English (United States)

Description: Method name whose parameter's description is being retrieved

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

 

ID: 4 - Name: ID

Language: English (United States)

Description: Parameter's ID

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

 

ID: 5 - Name: Language

Language: English (United States)

Description: String containing the language code to use to define the new parameter's description

Type: language - Min-Max Length: 6-6 - Reentr Key Member: Yes - Optional: No

 

ID: 6 - Name: Documentation

Language: English (United States)

Description: String containing the new parameter's description

Type: string - Min-Max Length: 1-256 - 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 ya existente de una solución específica (puede ser el token 'principal' inicial o un token de traductor)

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

 

ID: 3 - Name: MethodName

Language: Español (moderno)

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

Type: method - Min-Max Length: 6-64 - Reentr Key Member: Yes - 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: Yes - Optional: No

 

ID: 5 - Name: Language

Language: Español (moderno)

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

Type: language - Min-Max Length: 6-6 - Reentr Key Member: Yes - Optional: No

 

ID: 6 - Name: Documentation

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo la nueva descripción del parámetro

Type: string - Min-Max Length: 1-256 - 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 já existente de uma solução específica (pode ser o token 'mestre' inicial ou um token de tradutor)

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

 

ID: 3 - Name: MethodName

Language: Português (Brasil)

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

Type: method - Min-Max Length: 6-64 - Reentr Key Member: Yes - 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: Yes - Optional: No

 

ID: 5 - Name: Language

Language: Português (Brasil)

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

Type: language - Min-Max Length: 6-6 - Reentr Key Member: Yes - Optional: No

 

ID: 6 - Name: Documentation

Language: Português (Brasil)

Description: Sequência de caracteres contendo a nova descrição do parâmetro

Type: string - Min-Max Length: 1-256 - Reentr Key Member: No - Optional: No

---

Return Value

'MethodParameterDocumentationSetAllow' 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 'MethodParameterDocumentationSetAllow' 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#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#Prm0000004	Español (moderno)	ID de parámetro indicado no fue definido para este método
:@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#Prm0000004	Português (Brasil)	ID de parâmetro fornecido não foi definido para este método
:@Err#Sol0000017	Português (Brasil)	Tipo de token de solução tem que ser M ('master') ou T ('tradutor')

US Patent Requested