Home Page
English (1.167)
VersaCloud (1.163)
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 |
Name |
Language |
Description |
Type |
Min-Max Length |
Reentr Key Member |
Optional |
|---|---|---|---|---|---|---|---|
1 |
English (United States) |
E-mail address of new user |
7-128 |
Yes |
No |
||
2 |
FullName |
English (United States) |
Complete name of new user |
6-128 |
No |
No |
|
3 |
BirthDate |
English (United States) |
User's date of birth in yyyymmdd format |
8-8 |
No |
No |
|
4 |
DefaultLanguage |
English (United States) |
Default language used to communicate from VersaCloud with this user (e.g. through e-mail) |
6-6 |
No |
No |
|
5 |
Country |
English (United States) |
Two letter code identifying user's current country of residence |
2-2 |
No |
No |
|
6 |
SolutionToken |
English (United States) |
512-bit security key used to impersonate solutions |
128-128 |
No |
No |
|
7 |
Notify |
English (United States) |
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 |
4-5 |
No |
No |
|
1 |
Español (moderno) |
Dirección de correo electrónico del nuevo usuario |
7-128 |
Yes |
No |
||
2 |
FullName |
Español (moderno) |
Nombre completo del nuevo usuario |
6-128 |
No |
No |
|
3 |
BirthDate |
Español (moderno) |
Fecha de nascimiento del nuevo usuario en formato aaaammdd |
8-8 |
No |
No |
|
4 |
DefaultLanguage |
Español (moderno) |
Idioma inicial a utilizar en la comunicación con este usuario |
6-6 |
No |
No |
|
5 |
Country |
Español (moderno) |
Código de dos letras identificando el pais actual de residencia del usuario |
2-2 |
No |
No |
|
6 |
SolutionToken |
Español (moderno) |
Llave de seguridad de 512 bits usada para personificar soluciones |
128-128 |
No |
No |
|
7 |
Notify |
Español (moderno) |
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 |
4-5 |
No |
No |
|
1 |
Português (Brasil) |
Endereço de e-mail do novo usuário |
7-128 |
Yes |
No |
||
2 |
FullName |
Português (Brasil) |
Nome completo do novo usuário |
6-128 |
No |
No |
|
3 |
BirthDate |
Português (Brasil) |
Data de nascimento do novo usuário em formato aaaammdd |
8-8 |
No |
No |
|
4 |
DefaultLanguage |
Português (Brasil) |
Idioma padrão a usar na comunicação com este usuário |
6-6 |
No |
No |
|
5 |
Country |
Português (Brasil) |
Código de duas letras identificando o país atual de residência do usuário |
2-2 |
No |
No |
|
6 |
SolutionToken |
Português (Brasil) |
Chave de segurança de 512 bits usada para personificar soluções |
128-128 |
No |
No |
|
7 |
Notify |
Português (Brasil) |
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 |
4-5 |
No |
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
