Description

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

Language

Documentation

English (United States)

Asks for the creation of a new user group

Español (moderno)

Solicita la creación de un nuevo grupo de usuarios en VersaCloud

Português (Brasil)

Solicita a criação de um novo grupo de usuários

Parameters

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

Name

English (United States)

String containing the name of the new user group

string

4-32

Yes

No

3

Country

English (United States)

Country where the usergroup is based

country

2-2

No

No

4

Language

English (United States)

Default language to be used to communicate with group members (can be overridden by membership language)

language

6-6

No

No

5

SponsoringSolutionToken

English (United States)

If provided, the costs of executing this solution's method is debited directly from the group's balance (instead of individual users' balance)

solutiontoken

128-128

No

Yes

6

SponsorshipRemove

English (United States)

If True, requests removal if group's sponsorship by solution specified by previous parameter

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

Name

Español (moderno)

Secuencia de caracteres conteniendo el nombre del nuevo grupo de usuarios

string

4-32

Yes

No

3

Country

Español (moderno)

País en el cual el el grupo de usuarios está basado

country

2-2

No

No

4

Language

Español (moderno)

Idioma stándard a ser usado para comunicación con los miembros del grupo

language

6-6

No

No

5

SponsoringSolutionToken

Español (moderno)

Si informado, el costo de ejecución de los métodos de la solución es debitado directamente del saldo del grupo (en vez del saldo individual de cada usuario)

solutiontoken

128-128

No

Yes

6

SponsorshipRemove

Español (moderno)

Si True, solicita la eliminación del sponsoreo del grupo por la solución especifica por el parámetro anterior

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

Name

Português (Brasil)

Sequencia de caracteres contendo o nome do novo grupo de usuários

string

4-32

Yes

No

3

Country

Português (Brasil)

País no qual o grupo de usuarios está baseado

country

2-2

No

No

4

Language

Português (Brasil)

Idioma padrão a ser usado para comunicar com os membros do grupo

language

6-6

No

No

5

SponsoringSolutionToken

Português (Brasil)

Se fornecido, o custo de execução dos métodos da solução é debitado diretamente do saldo do grupo (em vez do saldo individual de cada usuário)

solutiontoken

128-128

No

Yes

6

SponsorshipRemove

Português (Brasil)

Se True, solicita a remoção do patrocínio do grupo pela solução especificada pelo parâmetro anterior

boolean

4-5

No

Yes

Return Value

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

Errorcode

Language

Description

:@Err#Grp0000011

English (United States)

Value provided as new usergroup name does not yet exist

:@Err#Sol0000006

English (United States)

Solution Token is not valid

:@Err#Sol0000032

English (United States)

Specified group is already being sponsored by another solution

:@Err#Sol0000034

English (United States)

Specified token does not match current group' sponsoring solution

:@Err#Sol0000036

English (United States)

It is not possible to remove sponsorship from an unsponsored group

:@Err#Grp0000011

Español (moderno)

Valor informado como nombre de grupo de usuarios todavía no existe

:@Err#Sol0000006

Español (moderno)

Token de solución no es válido

:@Err#Sol0000032

Español (moderno)

El grupo especificado ya es patrocinado por otra solución

:@Err#Sol0000034

Español (moderno)

El token informado no coincide con la solución que sponsorea el grupo

:@Err#Sol0000036

Español (moderno)

No es posible eliminar el sponsoreo de un grupo sin sponsor

:@Err#Grp0000011

Português (Brasil)

Valor fornecido como nome de grupo de usuários ainda não existe

:@Err#Sol0000006

Português (Brasil)

Token de solução não é válido

:@Err#Sol0000032

Português (Brasil)

O grupo especificado já é patrocinado por outra solução

:@Err#Sol0000034

Português (Brasil)

O token especificado não coincide com a solução patrocinadora do grupo

:@Err#Sol0000036

Português (Brasil)

Não é possível eliminar o patrocínio de um grupo não patrocinado

US Patent Requested