VersaCloud API ′MethodTypeSetAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests changing the method's return values' type and size
Español (moderno)	Pide cambiar el tipo y largo de los valores retornados por el método
Português (Brasil)	Solicita modificar o tipo e comprimento dos valores de retorno do método

Parameters

The following table describes all of 'MethodTypeSetAllow''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: Yes - Optional: No

 

ID: 3 - Name: MethodName

Language: English (United States)

Description: Method name for which the return values' maximum length is being retrieved

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

 

ID: 4 - Name: Type

Language: English (United States)

Description: New method's return values' type

Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: MinLen

Language: English (United States)

Description: New method's return values' minimum length

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

 

ID: 6 - Name: MaxLen

Language: English (United States)

Description: New method's return values' maximum length

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

 

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: Yes - Optional: No

 

ID: 3 - Name: MethodName

Language: Español (moderno)

Description: Nombre del método para el cual se está buscando el largo máximo de los valores que retorna

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

 

ID: 4 - Name: Type

Language: Español (moderno)

Description: Nuevo tipo de los valores retornados por el método

Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: MinLen

Language: Español (moderno)

Description: Nuevo largo mínimo de los valores retornados por el método

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

 

ID: 6 - Name: MaxLen

Language: Español (moderno)

Description: Nuevo largo máximo de los valores retornados por el método

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

 

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: Yes - Optional: No

 

ID: 3 - Name: MethodName

Language: Português (Brasil)

Description: Nome do método para o qual está sendo obtido o comprimento máximo dos valores que retorna

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

 

ID: 4 - Name: Type

Language: Português (Brasil)

Description: Novo tipo dos valores de retorno do método

Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: MinLen

Language: Português (Brasil)

Description: Novo comprimento mínimo dos valores de retorno do método

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

 

ID: 6 - Name: MaxLen

Language: Português (Brasil)

Description: Novo comprimento máximo dos valores de retorno do método

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

---

Return Value

'MethodTypeSetAllow' 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 'MethodTypeSetAllow' 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#Met0000911	English (United States)	A method's definition cannot be modified while there are active transactions created as instance of this same method
:@Err#Prm0000002	English (United States)	Requested parameter length is too short or too long
:@Err#Sol0000006	English (United States)	Solution Token is not valid
:@Err#Met0000011	Español (moderno)	Valor informado como nombre de método no es parte de la solución indicada
:@Err#Met0000911	Español (moderno)	La definición de un método no puede ser cambiada mientras haya transacciones activas e instanciadas a partir del método en cuestión
:@Err#Prm0000002	Español (moderno)	Largo pedido para el parámetro es más corto o más largo de lo permitido
:@Err#Sol0000006	Español (moderno)	Token de solución no es válido
:@Err#Met0000011	Português (Brasil)	Valor informado como nome de método não é parte da solução especificada
:@Err#Met0000911	Português (Brasil)	A definição de um método não pode ser modificada enquanto houver transações ativas e instanciadas a partir do método em questão
:@Err#Prm0000002	Português (Brasil)	Comprimento solicitado para o parâmetro é mais curto ou mais longo que o permitido
:@Err#Sol0000006	Português (Brasil)	Token de solução não é válido

US Patent Requested