Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'GroupMemberUntilSetAllow' Reference Documentation
Description
The following table displays the documentation for the 'GroupMemberUntilSetAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests to modify the final date for a specific user to be active part of an usergroup |
Español (moderno) |
Las solicitudes para modificar la fecha final para un usuario específico a ser parte activa de un grupo de usuarios |
Português (Brasil) |
Os pedidos para modificar a data final para um usuário específico a ser parte ativa de um grupo de usuários |
Parameters
The following table describes all of 'GroupMemberUntilSetAllow''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 |
UsergroupName |
English (United States) |
Name of usergroup the user already belongs to |
4-32 |
Yes |
No |
|
3 |
English (United States) |
E-mail address of user |
7-128 |
Yes |
No |
||
4 |
Until |
English (United States) |
User's new final group membership date/time |
10-24 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow |
48-48 |
No |
No |
|
2 |
UsergroupName |
Español (moderno) |
Nombre del grupo de usuarios al cual el usuario ya pertenece |
4-32 |
Yes |
No |
|
3 |
Español (moderno) |
Dirección de correo electrónico del usuario |
7-128 |
Yes |
No |
||
4 |
Until |
Español (moderno) |
Nueva fecha/horario final de afiliación al grupo |
10-24 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow |
48-48 |
No |
No |
|
2 |
UsergroupName |
Português (Brasil) |
Nome do grupo de usuários ao qual o usuário já pertence |
4-32 |
Yes |
No |
|
3 |
Português (Brasil) |
Endereço de e-mail do usuário |
7-128 |
Yes |
No |
||
4 |
Until |
Português (Brasil) |
Nova data/horário final de filiação ao grupo |
10-24 |
No |
No |
Return Value
'GroupMemberUntilSetAllow' 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 'GroupMemberUntilSetAllow' 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#Tim0000005 |
English (United States) |
Maximum date/time allowed cannot be further into the past than the minimum date/time allowed |
:@Err#Usr0000024 |
English (United States) |
Specified user does not have the needed right to invoke this API |
:@Err#Grp0000021 |
Español (moderno) |
Usuario todavía no es miembro del grupo de usuarios indicado |
:@Err#Tim0000005 |
Español (moderno) |
Fecha/hora máxima permitida no puede estar más em el pasado que la fecha/hora mínima permitida |
:@Err#Usr0000024 |
Español (moderno) |
Usuario informado no tiene los derechos necesarios para llamar esta API |
:@Err#Grp0000021 |
Português (Brasil) |
Usuário ainda não é membro do grupo de usuários especificado |
:@Err#Tim0000005 |
Português (Brasil) |
Data/hora máxima permitida não pode estar mais no passado que a data/hora mínima permitida |
:@Err#Usr0000024 |
Português (Brasil) |
Usuário especificado não possui os direitos necessários para chamar esta API |
US Patent Requested
