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

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

Login

English (United States)

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

operationhandle

48-48

No

No

2

SolutionToken

English (United States)

Valid solution token identifying solution the method corresponds to (must be a master token)

solutiontoken

128-128

Yes

No

3

MethodName

English (United States)

Method name to be added to solution (or is having new parameters added)

string

6-64

Yes

No

4

TimeToLive

English (United States)

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

unsigned

1-10

No

No

5

Returns

English (United States)

Type of values returned when method gets called

type

3-24

No

No

6

ReturnMinLen

English (United States)

Minimum length of values returned when method gets called

unsigned

1-3

No

No

7

ReturnMaxLen

English (United States)

Maximum length of values returned when method gets called

unsigned

1-3

No

No

8

Cost

English (United States)

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)

versacoin

1-11

No

Yes

9

Prepaid

English (United States)

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

boolean

4-5

No

Yes

10

Since

English (United States)

Initial date from which onwards the method will be effectively callable

timestamp

10-24

No

Yes

11

Until

English (United States)

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

timestamp

10-24

No

Yes

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al desarrollador responsable por crear el método

operationhandle

48-48

No

No

2

SolutionToken

Español (moderno)

Token de Solución válido identificando la solución a la cual el método pertenece (tiene que ser un token máster)

solutiontoken

128-128

Yes

No

3

MethodName

Español (moderno)

Nombre del método a ser adicionado a la solución (o al cual se le están adicionando nuevos parámetros)

string

6-64

Yes

No

4

TimeToLive

Español (moderno)

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)

unsigned

1-10

No

No

5

Returns

Español (moderno)

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

type

3-24

No

No

6

ReturnMinLen

Español (moderno)

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

unsigned

1-3

No

No

7

ReturnMaxLen

Español (moderno)

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

unsigned

1-3

No

No

8

Cost

Español (moderno)

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)

versacoin

1-11

No

Yes

9

Prepaid

Español (moderno)

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

boolean

4-5

No

Yes

10

Since

Español (moderno)

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

timestamp

10-24

No

Yes

11

Until

Español (moderno)

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

timestamp

10-24

No

Yes

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando desenvolvedor responsável pela criação do método

operationhandle

48-48

No

No

2

SolutionToken

Português (Brasil)

Token de Solução válido identificando a solução à qual o método pertence (tem que ser um token master)

solutiontoken

128-128

Yes

No

3

MethodName

Português (Brasil)

Nome do método a ser acrescentado à solução (ou ao qual novos parâmetros estão sendo adicionados)

string

6-64

Yes

No

4

TimeToLive

Português (Brasil)

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)

unsigned

1-10

No

No

5

Returns

Português (Brasil)

Tipo dos valores retornados quando o método é chamado

type

3-24

No

No

6

ReturnMinLen

Português (Brasil)

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

unsigned

1-3

No

No

7

ReturnMaxLen

Português (Brasil)

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

unsigned

1-3

No

No

8

Cost

Português (Brasil)

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)

versacoin

1-11

No

Yes

9

Prepaid

Português (Brasil)

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

boolean

4-5

No

Yes

10

Since

Português (Brasil)

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

timestamp

10-24

No

Yes

11

Until

Português (Brasil)

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

timestamp

10-24

No

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