Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′GroupBalanceAutoTransferAllow′ Reference Documentation
Description
The following table displays the documentation for the 'GroupBalanceAutoTransferAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests that user balance gets recharged from specific usergroup whenever user's balance too low |
Español (moderno) |
Solicita que el saldo del usuario sea recargado desde un grupo de usuarios específico siempre el saldo del usuario estuviera bajo |
Português (Brasil) |
Solicita que o saldo do usuário seja recarregado a partir de um grupo de usuário específico, sempre que o saldo do usuário ficar baixo |
Parameters
The following table describes all of 'GroupBalanceAutoTransferAllow''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: User
Language: English (United States)
Description: Identification of user account to be recharged automatically on low balance
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Group
Language: English (United States)
Description: Name of the usergroup to be used to obtain an amount of Versacoins to recharge user balance
Type: group - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 4 - Name: Threshold
Language: English (United States)
Description: If balance drops below this value, group can be used to recharge user's balance (use zero to switch off)
Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: No
ID: 5 - Name: Target
Language: English (United States)
Description: New balance to be achieved by recharge from group (if group has enough balance available) - zero to turn off
Type: versadime - Min-Max Length: 1-11 - 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: User
Language: Español (moderno)
Description: Identificación de la conta de usuario a ser recargada automáticamente en caso de saldo bajo
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Group
Language: Español (moderno)
Description: Nombre del grupo de usuarios a ser utilizado para obtener una cantidad de Versacoins para recargar el saldo del usuario
Type: group - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 4 - Name: Threshold
Language: Español (moderno)
Description: Si el saldo cae por debajo de este valor, el grupo podrá ser usado para recargar el saldo del usuario (use cero para deshabilitar)
Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: No
ID: 5 - Name: Target
Language: Español (moderno)
Description: Nuevo saldo a ser alcanzado por la recarga a partir del grupo (si el grupo tuviera saldo disponible suficiente) - cero para deshabilitar
Type: versadime - Min-Max Length: 1-11 - 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: User
Language: Português (Brasil)
Description: Identificação da conta de usúario a ser recarregada automaticamente em caso de saldo baixo
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Group
Language: Português (Brasil)
Description: Nome do grupo de usuários a ser usado para obter uma quantia de Versacoins para recarregar o saldo do usuário
Type: group - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 4 - Name: Threshold
Language: Português (Brasil)
Description: Se o saldo cair abaixo deste valor, o grupo poderá ser usada para recarregar o saldo do usuário (use zero para desligar)
Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: No
ID: 5 - Name: Target
Language: Português (Brasil)
Description: Novo saldo a ser atingido pela recarga a partir do grupo (desde que este possua saldo suficiente disponível) - zero para desligar
Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: No
---
Return Value
'GroupBalanceAutoTransferAllow' 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 'GroupBalanceAutoTransferAllow' 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#Grp0000041 |
English (United States) |
Login provided is not an administrator of specified group |
:@Err#Grp0000021 |
Español (moderno) |
Usuario todavía no es miembro del grupo de usuarios indicado |
:@Err#Grp0000041 |
Español (moderno) |
El login proveído no es administrador del grupo especificado |
:@Err#Grp0000021 |
Português (Brasil) |
Usuário ainda não é membro do grupo de usuários especificado |
:@Err#Grp0000041 |
Português (Brasil) |
O login fornecido não é administrador do grupo especificado |
US Patent Requested
