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

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

Login

English (United States)

Operation handle returned from succesful call of UserLoginAllow

operationhandle

48-48

No

No

2

GroupName

English (United States)

String containing the name to be verified as a valid usergroup

string

4-32

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow

operationhandle

48-48

No

No

2

GroupName

Español (moderno)

Secuencia de caracteres conteniendo el nombre a ser verificado como grupo de usuários válido

string

4-32

No

No

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow

operationhandle

48-48

No

No

2

GroupName

Português (Brasil)

Sequencia de caracteres contendo o nome a ser verificado como grupo de usuários válido

string

4-32

No

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