Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′GroupBalanceAddAllow′ Reference Documentation
Description
The following table displays the documentation for the 'GroupBalanceAddAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests the addition of a certain amount of VersaCoins to a usergroup's balance |
Español (moderno) |
Solicita la adición de una cierta cantidad de VersaCoins al saldo de un grupo de usuarios |
Português (Brasil) |
Solicita a adição de uma certa quantidade de VersaCoins ao saldo de um grupo de usuários |
Parameters
The following table describes all of 'GroupBalanceAddAllow''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: GroupName
Language: English (United States)
Description: Name of the usergroup to have its balance increased
Type: group - Min-Max Length: 4-32 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Balance
Language: English (United States)
Description: Amount to be added to the usergroup's balance, expressed as VersaCoin cents
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: GroupName
Language: Español (moderno)
Description: Nombre del grupo de usuarios que tendrá su saldo aumentado
Type: group - Min-Max Length: 4-32 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Balance
Language: Español (moderno)
Description: Cantidad a ser sumada al saldo del grupo de usuarios, expresada en céntimos de VersaCoin
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: GroupName
Language: Português (Brasil)
Description: Nome do grupo de usuários que terá seu saldo aumentado
Type: group - Min-Max Length: 4-32 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Balance
Language: Português (Brasil)
Description: Quantia a ser adicionada ao saldo do grupo de usuários, expressa em centavos de VersaCoin
Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: No
---
Return Value
'GroupBalanceAddAllow' 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 'GroupBalanceAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|
US Patent Requested
