Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′GroupMemberExpenseLimitAllow′ Reference Documentation
Description
The following table displays the documentation for the 'GroupMemberExpenseLimitAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests to define a speed limit for balance being recharged from a specific usergroup whenever user's balance gets too low |
Español (moderno) |
Solicita definir un límite para la velocidad de recarga de saldo a partir de un grupo de usuarios específico, siempre que el saldo del usuário estuviera muy bajo |
Português (Brasil) |
Solicita definir um limite para a velocidade de recarga de saldo a partir de um grupo de usuários específico, sempre que o saldo do usuário ficar muito baixo |
Parameters
The following table describes all of 'GroupMemberExpenseLimitAllow''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 group balance consumption
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Groupname
Language: English (United States)
Description: Name of the usergroup to be limited as a source to recharge user balance
Type: group - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 4 - 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: 5 - Name: Period
Language: English (United States)
Description: Time period (in milliseconds) over which a maximum amount of VersaCoins to be consumed is being specified
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 del grupo
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Groupname
Language: Español (moderno)
Description: Nombre del grupo de usuarios a ser limitado como fuente para recargar el saldo del usuario
Type: group - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 4 - 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: 5 - 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
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 do grupo
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Groupname
Language: Português (Brasil)
Description: Nome do grupo de usuários a ser limitado como fonte para recarregar o saldo do usuário
Type: group - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 4 - 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: 5 - 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
Type: hugeunsigned - Min-Max Length: 1-20 - Reentr Key Member: No - Optional: No
---
Return Value
'GroupMemberExpenseLimitAllow' 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 'GroupMemberExpenseLimitAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Grp0000021 |
English (United States) |
User is not yet a member of specified usergroup |
:@Err#Grp0000032 |
English (United States) |
User has not been marked as group administrator |
:@Err#Usr0000024 |
English (United States) |
Specified user does not have the needed right to invoke this API |
:@Err#Grp0000021 |
Español (moderno) |
Usuario todavía no es miembro del grupo de usuarios indicado |
:@Err#Grp0000032 |
Español (moderno) |
El usuario no fue indicado como administrador del grupo |
:@Err#Usr0000024 |
Español (moderno) |
Usuario informado no tiene los derechos necesarios para llamar esta API |
:@Err#Grp0000021 |
Português (Brasil) |
Usuário ainda não é membro do grupo de usuários especificado |
:@Err#Grp0000032 |
Português (Brasil) |
O usuário não foi apontado como administrador do grupo |
:@Err#Usr0000024 |
Português (Brasil) |
Usuário especificado não possui os direitos necessários para chamar esta API |
US Patent Requested
