Description

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

Language

Documentation

English (United States)

Requests to define a maximum speed for consumption of user balance (x versacoins every t milliseconds)

Español (moderno)

Las solicitudes para definir una velocidad máxima de consumo de equilibrio usuario (x versacoins a cada t segundos)

Português (Brasil)

Solicitações para definir uma velocidade máxima para o consumo de equilíbrio usuário (x versacoins a cada t milisegundos)

Parameters

The following table describes all of 'UserExpenseLimitAllow''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

operationhandle

48-48

No

No

2

Username

English (United States)

Identification of user account to be limited in balance consumption

email

7-128

No

No

3

Amount

English (United States)

Maximum amount of VersaCoins to be consumed in time period specified

versacoin

1-11

No

No

4

Period

English (United States)

Time period (in milliseconds) over which a maximum amount of VersaCoins to be consumed is being specified (if Amount and Period are zero, any existing limit gets deleted)

hugeunsigned

1-20

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow

operationhandle

48-48

No

No

2

Username

Español (moderno)

Identificación de la conta de usuario a ser limitada en su consumo de saldo

email

7-128

No

No

3

Amount

Español (moderno)

Cantidad máxima de VersaCoins a ser consumida en el período de tiempo indicado

versacoin

1-11

No

No

4

Period

Español (moderno)

Período de tiempo (en milisegundos) a lo largo del cual una cantidad máxima de VersaCoins a ser consumida está siendo especificada (si Amount y Period son ambos cero, cualquier límite existente es eliminado)

hugeunsigned

1-20

No

No

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow

operationhandle

48-48

No

No

2

Username

Português (Brasil)

Identificação da conta de usúario a ser limitada no consumo de saldo

email

7-128

No

No

3

Amount

Português (Brasil)

Quantia máxima de VersaCoins a ser consumida no período de tempo especificado

versacoin

1-11

No

No

4

Period

Português (Brasil)

Período de tempo (em milisegundos) ao longo do qual uma quantia máxima de VersaCoins a ser consumida está sendo especificada (se Amount e Period são ambos zero, qualquer limite existente é eliminado)

hugeunsigned

1-20

No

No

Return Value

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

Errorcode

Language

Description

:@Err#Usr0000002

English (United States)

Value provided as user e-mail is not registered with VersaCloud

:@Err#Usr0000024

English (United States)

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

:@Err#Usr0000002

Español (moderno)

Valor informado como correo electrónico de usuario no está registrado en VersaCloud

:@Err#Usr0000024

Español (moderno)

Usuario informado no tiene los derechos necesarios para llamar esta API

:@Err#Usr0000002

Português (Brasil)

Valor informado como e-mail de usuário não está registrado em VersaCloud

:@Err#Usr0000024

Português (Brasil)

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

US Patent Requested