Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′GroupValid′ Reference Documentation
Description
The following table displays the documentation for the 'GroupValid' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Verifies if a specific name designates an existing usergroup |
Español (moderno) |
Verifica si un nombre específico designa un grupo de usuarios existente |
Português (Brasil) |
Verifica se um nome específico designa um grupo de usuários existente |
Parameters
The following table describes all of 'GroupValid''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: String containing the name to be verified as a valid usergroup
Type: string - 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: Secuencia de caracteres conteniendo el nombre a ser verificado como grupo de usuários válido
Type: string - 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: Sequencia de caracteres contendo o nome a ser verificado como grupo de usuários válido
Type: string - Min-Max Length: 4-32 - Reentr Key Member: No - Optional: No
---
Return Value
'GroupValid' returns a value of type boolean (minimum length of returned values is 4 characters characters, while maximum length of returned values is 5 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 'GroupValid' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|
US Patent Requested
