VersaCloud API ′MethodDocumentationSetAllow′ Reference Documentation

Description

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

Parameters

The following table describes all of 'MethodDocumentationSetAllow''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 for which the description is being modified

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

ID: 4 - Name: Language

Language: English (United States)

Description: Language in which the description is being defined

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

ID: 5 - Name: Documentation

Language: English (United States)

Description: String containing the new solution'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á cambiando la descripción

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

ID: 4 - Name: Language

Language: Español (moderno)

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

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

ID: 5 - Name: Documentation

Language: Español (moderno)

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

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

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

ID: 4 - Name: Language

Language: Português (Brasil)

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

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

ID: 5 - Name: Documentation

Language: Português (Brasil)

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

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

US Patent Requested