VersaCloud API ′MethodAddAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests for addition of a new method (or new parameters for an existing method) to a specific solution managed by VersaCloud (to modify existing parameters use parameter specific APIs)
Español (moderno)	Solicita la adición de un nuevo método (ou nuevos parámetros a un método existente) para una solución específica gerenciada por VersaCloud (para modificar parámetros ya existentes use las APIs específicas para parámetros individuales)
Português (Brasil)	Solicita a inclusão de um novo método (ou novos parâmetros para um método existente) de uma solução específica gerenciada por VersaCloud (para modificar parâmetros já existentes use as APIs específicas para parâmetros individuais)

Parameters

The following table describes all of 'MethodAddAllow''s parameters, in every language available.

 

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow, identifying developer responsible for method's creation

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 to be added to solution (or is having new parameters added)

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

 

ID: 4 - Name: TimeToLive

Language: English (United States)

Description: Number of seconds this method will survive in a pending state, before being rollbacked automatically (use 0 for non-transactional methods)

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

 

ID: 5 - Name: Returns

Language: English (United States)

Description: Type of values returned when method gets called

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

 

ID: 6 - Name: ReturnMinLen

Language: English (United States)

Description: Minimum length of values returned when method gets called

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

 

ID: 7 - Name: ReturnMaxLen

Language: English (United States)

Description: Maximum length of values returned when method gets called

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

 

ID: 8 - Name: Cost

Language: English (United States)

Description: Number of VersaCoin cents the user will be charged for a succesful run of this method (can be zero if a specific method call is not to be charged to users; however, VersaCloud does not allow for solutions that do not charge for any method call)

Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: Yes

 

ID: 9 - Name: Prepaid

Language: English (United States)

Description: 'True' indicates prepaid methods; 'False' corresponds to postpaid (to be implemented in the future)

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: Yes

 

ID: 10 - Name: Since

Language: English (United States)

Description: Initial date from which onwards the method will be effectively callable

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: Yes

 

ID: 11 - Name: Until

Language: English (United States)

Description: Final date from which onwards the method will not be callable anymore

Type: timestamp - Min-Max Length: 10-24 - 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 por crear el método

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 a ser adicionado a la solución (o al cual se le están adicionando nuevos parámetros)

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

 

ID: 4 - Name: TimeToLive

Language: Español (moderno)

Description: Cantidad de segundos que este método existirá en estado pendiente, antes que se inicie su rollback automático (use zero para métodos que não correspondem a transações)

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

 

ID: 5 - Name: Returns

Language: Español (moderno)

Description: Tipo de los valores retornados cuando el método es llamado

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

 

ID: 6 - Name: ReturnMinLen

Language: Español (moderno)

Description: Largo mínimo de los valores retornados cuando el método es llamado

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

 

ID: 7 - Name: ReturnMaxLen

Language: Español (moderno)

Description: Largo máximo de los valores retornados cuando el método es llamado

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

 

ID: 8 - Name: Cost

Language: Español (moderno)

Description: Cantidad de céntimos de VersaCoin que serán debitados al usuario por la ejecución exitosa de este método (puede ser cero si el uso del método no debe ser cobrado del usuario; pero, VersaCloud no permite soluciones que no cobran por ninguno de sus métodos)

Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: Yes

 

ID: 9 - Name: Prepaid

Language: Español (moderno)

Description: 'True' indica que el método es prepago; 'False' corresponde a pospago (a ser implementado en el futuro)

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: Yes

 

ID: 10 - Name: Since

Language: Español (moderno)

Description: Fecha inicial a partir de la cual este método podrá efectivamente ser llamado

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: Yes

 

ID: 11 - Name: Until

Language: Español (moderno)

Description: Fecha final a partir de la cual este método ya no podrá más ser llamado

Type: timestamp - Min-Max Length: 10-24 - 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 pela criação do método

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 a ser acrescentado à solução (ou ao qual novos parâmetros estão sendo adicionados)

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

 

ID: 4 - Name: TimeToLive

Language: Português (Brasil)

Description: Quantidade de segundos este método sobreviverá em estado pendente, antes de se iniciar o rollback automático (use zero para métodos que não correspondem a transações)

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

 

ID: 5 - Name: Returns

Language: Português (Brasil)

Description: Tipo dos valores retornados quando o método é chamado

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

 

ID: 6 - Name: ReturnMinLen

Language: Português (Brasil)

Description: Comprimento mínimo dos valores retornados quando o método é chamado

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

 

ID: 7 - Name: ReturnMaxLen

Language: Português (Brasil)

Description: Comprimento máximo dos valores retornados quando o método é chamado

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

 

ID: 8 - Name: Cost

Language: Português (Brasil)

Description: Quantidade de centavos de VersaCoin que serão debitados do usuário pela execução bem sucedida do método (pode ser zero se o uso deste método não é cobrado do usuário; porém, VersaCloud não permite soluções que não debitem nenhuma chamada de método)

Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: Yes

 

ID: 9 - Name: Prepaid

Language: Português (Brasil)

Description: 'True' indica que o método é pré-pago; 'False' corresponde a pós-pago (a ser implementado en el futuro)

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: Yes

 

ID: 10 - Name: Since

Language: Português (Brasil)

Description: Data inicial a partir da qual este método poderá efetivamente ser chamado

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: Yes

 

ID: 11 - Name: Until

Language: Português (Brasil)

Description: Data final a partir da qual este método não poderá mais ser chamado

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: Yes

---

Return Value

'MethodAddAllow' 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 'MethodAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

Errorcode	Language	Description
:@Err#Api9999991	English (United States)	Processing of postpaid method calls is not yet implemented
:@Err#Met0000027	English (United States)	Minimum length must be less or equal than maximum length of parameter's value
:@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#Sol0000006	English (United States)	Solution Token is not valid
:@Err#Tim0000002	English (United States)	Maximum date/time allowed cannot be already in the past
:@Err#Tim0000009	English (United States)	Time interval specified is not correct
:@Err#Api9999991	Español (moderno)	El procesamiento de métodos póspagos aún no está implementado
:@Err#Met0000027	Español (moderno)	Largo mínimo debe ser menor o igual que el largo máximo del valor del parámetro
:@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#Sol0000006	Español (moderno)	Token de solución no es válido
:@Err#Tim0000002	Español (moderno)	Data/hora máxima permitida no puede ser un instante que ya esté en el pasado
:@Err#Tim0000009	Español (moderno)	El intervalo de tiempo especificado no es correcto
:@Err#Api9999991	Português (Brasil)	O processamento de métodos pós-pagos ainda não está implementado
:@Err#Met0000027	Português (Brasil)	Comprimento mínimo deve ser menor ou igual que o comprimento máximo do valor do parâmetro
:@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#Sol0000006	Português (Brasil)	Token de solução não é válido
:@Err#Tim0000002	Português (Brasil)	Data/hora máxima permitida não pode ser um instante que já esteja no passado
:@Err#Tim0000009	Português (Brasil)	O intervalo de tempo especificado não é correto

US Patent Requested