Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′MethodParameterNameSetAllow′ Reference Documentation
Description
The following table displays the documentation for the 'MethodParameterNameSetAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests changing the name of a specific method parameter name |
Español (moderno) |
Solicita cambiar el nombre de un parámetro de un método específico |
Português (Brasil) |
Solicita modificar o nome de um parâmetro de um método específico |
Parameters
The following table describes all of 'MethodParameterNameSetAllow''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 (must be a master 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 minimum interval among calls by same user is being modified
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: ParameterName
Language: English (United States)
Description: New name of specific method parameter
Type: string - Min-Max Length: 4-128 - 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 (tiene que ser un token máster)
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 el intervalo mínimo entre llamadas de un mismo usuario
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: ParameterName
Language: Español (moderno)
Description: Nuevo nombre del parámetro del método específico
Type: string - Min-Max Length: 4-128 - 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 (tem que ser um token master)
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 o intervalo mínimo entre chamadas por um mesmo usuário está sendo modificado
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: ParameterName
Language: Português (Brasil)
Description: Novo nome do parâmetro do método especificado
Type: string - Min-Max Length: 4-128 - Reentr Key Member: No - Optional: No
---
Return Value
'MethodParameterNameSetAllow' 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 'MethodParameterNameSetAllow' 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#Prm0000006 |
English (United States) |
Name provided as new parameter is already in use for this method |
:@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#Prm0000004 |
Español (moderno) |
ID de parámetro indicado no fue definido para este método |
:@Err#Prm0000006 |
Español (moderno) |
Nombre indicado como novo parámetro ya está en uso para este método |
:@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#Prm0000004 |
Português (Brasil) |
ID de parâmetro fornecido não foi definido para este método |
:@Err#Prm0000006 |
Português (Brasil) |
Nome fornecido como novo parâmetro já está em uso para este método |
:@Err#Sol0000006 |
Português (Brasil) |
Token de solução não é válido |
US Patent Requested
