Description

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

Language

Documentation

English (United States)

Requests the execution of a specific method on behalf of a certain user (method being invoked's time to live will be assumed as time to live for this API call)

Español (moderno)

Solicita la ejecución de un método específico por cuenta de un usuario determinado (el tiempo máximo de ejecución para esta llamada de API es determinado por el tiempo máximo de llamada del método siendo accionado)

Português (Brasil)

Solicita a execução de um método específico por conta de um determinado usuário (o tempo máximo de execução para esta chamada de API é definido pelo tempo máximo de chamada do método sendo acionado)

Parameters

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

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

SolutionLogin

English (United States)

Operation handle returned from succesful call to SolutionLoginAllow (identifies solution and user)

operationhandle

48-48

Yes

No

2

MethodName

English (United States)

Name of method to be called

method

6-64

Yes

No

3

Cost

English (United States)

Amount to be charged (if null, will use method's default cost)

versacoin

1-11

No

Yes

4

Duration

English (United States)

Maximum duration of this transaction (if omitted, will use method's default maximum duration)

unsigned

1-9

No

Yes

1

SolutionLogin

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a SolutionLoginAllow (identifica a la solución y al usuario)

operationhandle

48-48

Yes

No

2

MethodName

Español (moderno)

Nombre del método a ser llamado

method

6-64

Yes

No

3

Cost

Español (moderno)

Valor a ser debitado (si nulo, es utilizado el costo standard del método)

versacoin

1-11

No

Yes

4

Duration

Español (moderno)

Duración máximo de esta transacción (si omitida, será utilizada la duración máxima standard del método)

unsigned

1-9

No

Yes

1

SolutionLogin

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a SolutionLoginAllow (identifica a solução e o usuário)

operationhandle

48-48

Yes

No

2

MethodName

Português (Brasil)

Nome do método a ser chamado

method

6-64

Yes

No

3

Cost

Português (Brasil)

Quantia a ser debitada (se nula, é usado o custo padrão do método)

versacoin

1-11

No

Yes

4

Duration

Português (Brasil)

Duração máxima desta transação (se omitida, será usada a duração máximo padrão do método)

unsigned

1-9

No

Yes

Return Value

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

Errorcode

Language

Description

:@Err#Api0000011

English (United States)

Method cannot be called now (verify method's initial and final date/time)

:@Err#Api0000015

English (United States)

Consecutive method call has to wait for method's minimum call delay

:@Err#Api0000018

English (United States)

Consecutive method call by a single user has to wait for user's method's minimum call delay

:@Err#Bal0000000

English (United States)

User's current balance is insufficient to run this call

:@Err#Met0000124

English (United States)

MethodInvokeAllow first parameter must be a valid operation handle returned by SolutionLoginAllow (verify if login into solution has not timed out)

:@Err#Met0000128

English (United States)

MethodInvokeAllow second parameter must be the name of a method that is part of the solution SolutionLoginAllow's first parameter points at

:@Err#Sol0000003

English (United States)

Usage of specified solution is not allowed at this time

:@Err#Usr0000024

English (United States)

Specified user does not have the needed right to invoke this API

:@Err#Api0000011

Español (moderno)

Método no puede ser llamado ahora (observe fecha/hora inicial y final de validez del método)

:@Err#Api0000015

Español (moderno)

Llamadas consecutivas de un método deben esperar el tiempo mínimo definido entre dos llamadas

:@Err#Api0000018

Español (moderno)

Llamadas consecutivas de un método por un único usuario deben esperar el tiempo mínimo definido entre dos llamadas para cada usuario

:@Err#Bal0000000

Español (moderno)

Saldo actual del usuario no es suficiente para ejecutar esta llamada

:@Err#Met0000124

Español (moderno)

El primer parámetro de MethodInvokeAllow debe ser un protocolo de operación válido obtenido de SolutionLoginAllow (verifique si la sesión de uso de la solución no ha caducado)

:@Err#Met0000128

Español (moderno)

El segundo parámetro de MethodInvokeAllow debe ser el nombre de un método que sea parte de la solución para la cual el primer parámetro de SolutionLoginAllow apunta

:@Err#Sol0000003

Español (moderno)

El uso de la solución indicada no es permitido en este momento

:@Err#Usr0000024

Español (moderno)

Usuario informado no tiene los derechos necesarios para llamar esta API

:@Err#Api0000011

Português (Brasil)

Método não pode ser chamado agora (verifique data/hora inicial e final de uso do método)

:@Err#Api0000015

Português (Brasil)

Chamadas consecutivas de um método devem aguardar o tempo mínimo estabelecido entre duas chamadas

:@Err#Api0000018

Português (Brasil)

Chamadas consecutivas de um método por um único usuário devem aguardar o tempo mínimo estabelecido entre duas chamadas para cada usuário

:@Err#Bal0000000

Português (Brasil)

Saldo atual do usuário é insuficiente para executar esta chamada

:@Err#Met0000124

Português (Brasil)

O primeiro parâmetro de MethodInvokeAllow deve ser um protocolo de operação válido retornado por SolutionLoginAllow (verifique se a sessão de uso da solução não há expirado)

:@Err#Met0000128

Português (Brasil)

O segundo parâmetro de MethodInvokeAllow deve ser o nome de um método que seja parte da solução para a qual o primeiro parâmetro de SolutionLoginAllow aponta

:@Err#Sol0000003

Português (Brasil)

Uso da solução especificada não é pertimido neste momento

:@Err#Usr0000024

Português (Brasil)

Usuário especificado não possui os direitos necessários para chamar esta API

US Patent Requested