Description

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

Language

Documentation

English (United States)

Request to add or remove group administrator status to a current usergroup member

Español (moderno)

Solicita que se añada ou elimine el status de administrador a un miembro actual de un grupo de usuarios

Português (Brasil)

Solicita adicionar ou remover status de administrador de um membro atual de um grupo de usuários

Parameters

The following table describes all of 'GroupAdminAddAllow''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)

Name of usergroup the user already belongs to

group

4-32

Yes

No

3

User

English (United States)

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

email

7-128

Yes

No

4

Admin

English (United States)

Administrator status to be assigned to specified user

boolean

4-5

No

Yes

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)

Nombre del grupo de usuarios al cual el usuario ya pertenece

group

4-32

Yes

No

3

User

Español (moderno)

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

email

7-128

Yes

No

4

Admin

Español (moderno)

Status de administrador a ser atribuido al usuário

boolean

4-5

No

Yes

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)

Nome do grupo de usuários ao qual o usuário já pertence

group

4-32

Yes

No

3

User

Português (Brasil)

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

email

7-128

Yes

No

4

Admin

Português (Brasil)

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

boolean

4-5

No

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):

Errorcode

Language

Description

:@Err#Grp0000021

English (United States)

User is not yet a member of specified usergroup

:@Err#Grp0000031

English (United States)

User has already been marked as group administrator

:@Err#Grp0000032

English (United States)

User has not been marked as group administrator

:@Err#Grp0000021

Español (moderno)

Usuario todavía no es miembro del grupo de usuarios indicado

:@Err#Grp0000031

Español (moderno)

El usuario ya fue indicado como administrador del grupo

:@Err#Grp0000032

Español (moderno)

El usuario no fue indicado como administrador del grupo

:@Err#Grp0000021

Português (Brasil)

Usuário ainda não é membro do grupo de usuários especificado

:@Err#Grp0000031

Português (Brasil)

O usuário já foi apontado como administrador do grupo

:@Err#Grp0000032

Português (Brasil)

O usuário não foi apontado como administrador do grupo

US Patent Requested