Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′GroupBalanceGet′ Reference Documentation
Description
The following table displays the documentation for the 'GroupBalanceGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves a usergroup's current balance (limited to users who are group members) |
Español (moderno) |
Recupera el equilibrio actual de un grupo de usuarios (limitado a los usuarios que son miembros del grupo) |
Português (Brasil) |
Recupera saldo atual de um grupo de usuários (limitado a usuários que são membros do grupo) |
Parameters
The following table describes all of 'GroupBalanceGet''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 be queried
Type: group - Min-Max Length: 4-32 - 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 a ser consultado
Type: group - Min-Max Length: 4-32 - 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 a ser consultado
Type: group - Min-Max Length: 4-32 - Reentr Key Member: No - Optional: No
---
Return Value
'GroupBalanceGet' returns a value of type hugeunsigned (minimum length of returned values is one character characters, while maximum length of returned values is 20 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 'GroupBalanceGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|
US Patent Requested
