VersaCloud API ′UserExpenseLimitAllow′ Reference Documentation

Description

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

Parameters

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

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: Username

Language: English (United States)

Description: Identification of user account to be limited in balance consumption

Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No

ID: 3 - Name: Amount

Language: English (United States)

Description: Maximum amount of VersaCoins to be consumed in time period specified

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

ID: 4 - Name: Period

Language: English (United States)

Description: 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)

Type: hugeunsigned - Min-Max Length: 1-20 - 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

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: Username

Language: Español (moderno)

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

Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No

ID: 3 - Name: Amount

Language: Español (moderno)

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

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

ID: 4 - Name: Period

Language: Español (moderno)

Description: 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)

Type: hugeunsigned - Min-Max Length: 1-20 - 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

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: Username

Language: Português (Brasil)

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

Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No

ID: 3 - Name: Amount

Language: Português (Brasil)

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

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

ID: 4 - Name: Period

Language: Português (Brasil)

Description: 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)

Type: hugeunsigned - Min-Max Length: 1-20 - Reentr Key Member: No - Optional: 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):

US Patent Requested