VersaCloud API ′UserAddAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests addition of a new user to the VersaCloud platform
Español (moderno)	Pide que se agregue un nuevo usuario a la plataforma VersaCloud
Português (Brasil)	Solicita a adição de um novo usuário à plataforma VersaCloud

Parameters

The following table describes all of 'UserAddAllow''s parameters, in every language available.

 

ID: 1 - Name: Email

Language: English (United States)

Description: E-mail address of new user

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

 

ID: 2 - Name: FullName

Language: English (United States)

Description: Complete name of new user

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

 

ID: 3 - Name: BirthDate

Language: English (United States)

Description: User's date of birth in yyyymmdd format

Type: date - Min-Max Length: 8-8 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: DefaultLanguage

Language: English (United States)

Description: Default language used to communicate from VersaCloud with this user (e.g. through e-mail)

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

 

ID: 5 - Name: Country

Language: English (United States)

Description: Two letter code identifying user's current country of residence

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

 

ID: 6 - Name: SolutionToken

Language: English (United States)

Description: 512-bit security key used to impersonate solutions

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

 

ID: 7 - Name: Notify

Language: English (United States)

Description: If True, VersaCloud will send a welcome message to user, on behalf of Solution, instructing how to complete the user's registration process to create his password

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: No

 

ID: 1 - Name: Email

Language: Español (moderno)

Description: Dirección de correo electrónico del nuevo usuario

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

 

ID: 2 - Name: FullName

Language: Español (moderno)

Description: Nombre completo del nuevo usuario

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

 

ID: 3 - Name: BirthDate

Language: Español (moderno)

Description: Fecha de nascimiento del nuevo usuario en formato aaaammdd

Type: date - Min-Max Length: 8-8 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: DefaultLanguage

Language: Español (moderno)

Description: Idioma inicial a utilizar en la comunicación con este usuario

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

 

ID: 5 - Name: Country

Language: Español (moderno)

Description: Código de dos letras identificando el pais actual de residencia del usuario

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

 

ID: 6 - Name: SolutionToken

Language: Español (moderno)

Description: Llave de seguridad de 512 bits usada para personificar soluciones

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

 

ID: 7 - Name: Notify

Language: Español (moderno)

Description: Si True, VersaCloud enviará un mensaje de bienvenida al usuario, por cuenta de la solución, instruyendo al usuario sobre como completar el processo de registro y criar su contraseña

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: No

 

ID: 1 - Name: Email

Language: Português (Brasil)

Description: Endereço de e-mail do novo usuário

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

 

ID: 2 - Name: FullName

Language: Português (Brasil)

Description: Nome completo do novo usuário

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

 

ID: 3 - Name: BirthDate

Language: Português (Brasil)

Description: Data de nascimento do novo usuário em formato aaaammdd

Type: date - Min-Max Length: 8-8 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: DefaultLanguage

Language: Português (Brasil)

Description: Idioma padrão a usar na comunicação com este usuário

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

 

ID: 5 - Name: Country

Language: Português (Brasil)

Description: Código de duas letras identificando o país atual de residência do usuário

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

 

ID: 6 - Name: SolutionToken

Language: Português (Brasil)

Description: Chave de segurança de 512 bits usada para personificar soluções

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

 

ID: 7 - Name: Notify

Language: Português (Brasil)

Description: Se True, VersaCloud enviará uma mensagem de boas vindas para o usuário, por conta da solução, instruindo o usuário sobre como completar o processo de registro e criar sua senha

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: No

---

Return Value

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

Errorcode	Language	Description
:@Err#Sol0000008	English (United States)	Solution Token type must be either M ('master') or Q ('query')
:@Err#Usr0000001	English (United States)	Value provided as user e-mail is already registered with VersaCloud
:@Err#Usr0000006	English (United States)	Value provided as user's birthdate is still in the future or too far into the past (more than 120 years of age)
:@Err#Sol0000008	Español (moderno)	Tipo de token de solución tiene que ser M ('master') o Q ('query')
:@Err#Usr0000001	Español (moderno)	Valor informado como correo electrónico de usuario ya está registrado en VersaCloud
:@Err#Usr0000006	Español (moderno)	Valor informado como fecha de nascimiento del usuario aún es futura o está muy lejos en el pasado (más de 120 años de edad)
:@Err#Sol0000008	Português (Brasil)	Tipo de token de solução tem que ser M ('master') ou Q ('query')
:@Err#Usr0000001	Português (Brasil)	Valor informado como e-mail de usuário já está registrado em VersaCloud
:@Err#Usr0000006	Português (Brasil)	Valor informado como data de nascimento do usuário ainda é futura ou é longe demais no passado (mais de 120 anos de idade)

US Patent Requested