Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'GroupMemberAddAllow' Reference Documentation
Description
The following table displays the documentation for the 'GroupMemberAddAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests to add a specific user to be standard member of an usergroup |
Español (moderno) |
Solicita añadir un usuario específico a un grupo de usuarios |
Português (Brasil) |
Solicita adicionar um usuário específico a um grupo de usuários |
Parameters
The following table describes all of 'GroupMemberAddAllow''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 |
48-48 |
No |
No |
|
2 |
GroupName |
English (United States) |
Name of usergroup the user will be added to |
4-32 |
No |
No |
|
3 |
English (United States) |
E-mail address of user |
7-128 |
No |
No |
||
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow |
48-48 |
No |
No |
|
2 |
GroupName |
Español (moderno) |
Nombre del grupo de usuarios al cual el usuario será adicionado |
4-32 |
No |
No |
|
3 |
Español (moderno) |
Dirección de correo electrónico del usuario |
7-128 |
No |
No |
||
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow |
48-48 |
No |
No |
|
2 |
GroupName |
Português (Brasil) |
Nome do grupo de usuários ao qual o usuário será adicionado |
4-32 |
No |
No |
|
3 |
Português (Brasil) |
Endereço de e-mail do usuário |
7-128 |
No |
No |
Return Value
'GroupMemberAddAllow' 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 'GroupMemberAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Grp0000022 |
English (United States) |
User is already a member of specified usergroup |
:@Err#Usr0000002 |
English (United States) |
Value provided as user e-mail is not registered with VersaCloud |
:@Err#Grp0000022 |
Español (moderno) |
Usuario ya es miembro del grupo de usuarios indicado |
:@Err#Usr0000002 |
Español (moderno) |
Valor informado como correo electrónico de usuario no está registrado en VersaCloud |
:@Err#Grp0000022 |
Português (Brasil) |
Usuário já é membro do grupo de usuários especificado |
:@Err#Usr0000002 |
Português (Brasil) |
Valor informado como e-mail de usuário não está registrado em VersaCloud |
US Patent Requested
