Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′MethodParameterDocumentationGet′ Reference Documentation
Description
The following table displays the documentation for the 'MethodParameterDocumentationGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves description of a method's purpose |
Español (moderno) |
Recupera descripción del propósito de un método |
Português (Brasil) |
Recupera descrição do propósito de um método |
Parameters
The following table describes all of 'MethodParameterDocumentationGet''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 parameter's description is being retrieved
Type: method - Min-Max Length: 6-64 - Reentr Key Member: No - Optional: No
ID: 4 - Name: ID
Language: English (United States)
Description: Parameter's ID
Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: No
ID: 5 - Name: Language
Language: English (United States)
Description: String containing the language code to use to retrieve the parameter's description
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 del método
Type: method - Min-Max Length: 6-64 - Reentr Key Member: No - 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: No - Optional: No
ID: 5 - Name: Language
Language: Español (moderno)
Description: Secuencia de caracteres conteniendo el código de idioma a ser usado para obtener la descripción del parámetro
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 está obtendo a descrição do parâmetro
Type: method - Min-Max Length: 6-64 - Reentr Key Member: No - 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: No - Optional: No
ID: 5 - Name: Language
Language: Português (Brasil)
Description: Sequencia de caracteres contendo o código de idioma a ser usado para obter a descrição do parâmetro
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
---
Return Value
'MethodParameterDocumentationGet' 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 'MethodParameterDocumentationGet' 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#Prm0000243 |
English (United States) |
Parameter's description has not been defined in specified language |
:@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#Prm0000243 |
Español (moderno) |
Descripción del parámetro no ha sido definido en el idioma indicado |
:@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#Prm0000243 |
Português (Brasil) |
Descrição do parâmetro não foi definida no idioma especificado |
US Patent Requested
