VersaCloud API ′GroupAddAllow′ Reference Documentation

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

Language: English (United States)

Description: String containing the name of the new user group

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

 

ID: 3 - Name: Country

Language: English (United States)

Description: Country where the usergroup is based

Type: country - Min-Max Length: 2-2 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: Language

Language: English (United States)

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

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: SponsoringSolutionToken

Language: English (United States)

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

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

 

ID: 6 - Name: SponsorshipRemove

Language: English (United States)

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

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

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo el nombre del nuevo grupo de usuarios

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

 

ID: 3 - Name: Country

Language: Español (moderno)

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

Type: country - Min-Max Length: 2-2 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: Language

Language: Español (moderno)

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

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: SponsoringSolutionToken

Language: Español (moderno)

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

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

 

ID: 6 - Name: SponsorshipRemove

Language: Español (moderno)

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

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

Language: Português (Brasil)

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

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

 

ID: 3 - Name: Country

Language: Português (Brasil)

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

Type: country - Min-Max Length: 2-2 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: Language

Language: Português (Brasil)

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

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: SponsoringSolutionToken

Language: Português (Brasil)

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

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

 

ID: 6 - Name: SponsorshipRemove

Language: Português (Brasil)

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

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: 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