VersaCloud API ′MethodDocumentationGet′ Reference Documentation

Description

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

Parameters

The following table describes all of 'MethodDocumentationGet''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: Valid solution token identifying solution the method corresponds to

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

ID: 3 - Name: MethodName

Language: English (United States)

Description: Method name whose description is being requested

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

ID: 4 - Name: Language

Language: English (United States)

Description: Language the description should be retrieved in

Type: language - Min-Max Length: 6-6 - 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 de Solución válido identificando la solución a la cual el método pertenece

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

ID: 3 - Name: MethodName

Language: Español (moderno)

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

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

ID: 4 - Name: Language

Language: Español (moderno)

Description: Idioma en el cual la descripción debe ser obtenida

Type: language - Min-Max Length: 6-6 - 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 de Solução válido identificando a solução à qual o método pertence

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

ID: 3 - Name: MethodName

Language: Português (Brasil)

Description: Nome do método para o qual a descrição está sendo obtida

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

ID: 4 - Name: Language

Language: Português (Brasil)

Description: Idioma no qual a descrição deve ser obtida

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: 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):

US Patent Requested