Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'GroupExpenseLimitAllow' Reference Documentation
Description
The following table displays the documentation for the 'GroupExpenseLimitAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests to define a maximum speed for consumption of usergroup balance (x coins every t seconds) |
Español (moderno) |
Las solicitudes para definir una velocidad máxima de consumo de equilibrio grupo de usuarios (x monedas cada t segundos) |
Português (Brasil) |
Solicitações para definir uma velocidade máxima para o consumo de equilíbrio de Grupos (x moedas a cada t segundos) |
Parameters
The following table describes all of 'GroupExpenseLimitAllow''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 |
48-48 |
No |
No |
|
2 |
Groupname |
English (United States) |
Identification of user group to be limited in balance consumption |
4-32 |
No |
No |
|
3 |
Amount |
English (United States) |
Maximum amount of VersaCoins to be consumed in time period specified |
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) |
1-20 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow |
48-48 |
No |
No |
|
2 |
Groupname |
Español (moderno) |
Identificación del grupo de usuarios a ser limitado en su consumo de saldo |
4-32 |
No |
No |
|
3 |
Amount |
Español (moderno) |
Cantidad máxima de VersaCoins a ser consumida en el período de tiempo indicado |
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) |
1-20 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow |
48-48 |
No |
No |
|
2 |
Groupname |
Português (Brasil) |
Identificação do grupo de usúario a ser limitado no consumo de saldo |
4-32 |
No |
No |
|
3 |
Amount |
Português (Brasil) |
Quantia máxima de VersaCoins a ser consumida no período de tempo especificado |
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) |
1-20 |
No |
No |
Return Value
'GroupExpenseLimitAllow' 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 'GroupExpenseLimitAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Grp0000032 |
English (United States) |
User has not been marked as group administrator |
:@Err#Grp0000032 |
Español (moderno) |
El usuario no fue indicado como administrador del grupo |
:@Err#Grp0000032 |
Português (Brasil) |
O usuário não foi apontado como administrador do grupo |
US Patent Requested
