VersaCloud API ′GroupAdminAddAllow′ Reference Documentation

Description

The following table displays the documentation for the 'GroupAdminAddAllow' API in all languages currently available:

Parameters

The following table describes all of 'GroupAdminAddAllow''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 usergroup the user already belongs to

Type: group - Min-Max Length: 4-32 - Reentr Key Member: Yes - Optional: No

ID: 3 - Name: User

Language: English (United States)

Description: E-mail address of user to be promoted to group administrator

Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No

ID: 4 - Name: Admin

Language: English (United States)

Description: Administrator status to be assigned to specified user

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: Yes

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 al cual el usuario ya pertenece

Type: group - Min-Max Length: 4-32 - Reentr Key Member: Yes - Optional: No

ID: 3 - Name: User

Language: Español (moderno)

Description: Dirección de correo electrónico del usuario a ser promovido a administrador del grupo

Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No

ID: 4 - Name: Admin

Language: Español (moderno)

Description: Status de administrador a ser atribuido al usuário

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: Yes

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 ao qual o usuário já pertence

Type: group - Min-Max Length: 4-32 - Reentr Key Member: Yes - Optional: No

ID: 3 - Name: User

Language: Português (Brasil)

Description: Endereço de e-mail do usuário a ser promovido a administrador do grupo

Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No

ID: 4 - Name: Admin

Language: Português (Brasil)

Description: Status de administrador a ser atribuído ao usuário

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: Yes

---

Return Value

'GroupAdminAddAllow' 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 'GroupAdminAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

US Patent Requested