Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'SolutionLoginAllow' Reference Documentation
Description
The following table displays the documentation for the 'SolutionLoginAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Request to login a user into a specific solution, so that he can use its method's |
Español (moderno) |
Solicitud para iniciar sesión un usuario en una solución específica, para que pueda utilizar su método de |
Português (Brasil) |
Solicitação para acessar um usuário em uma solução específica, para que ele possa usar seu método de |
Parameters
The following table describes all of 'SolutionLoginAllow''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, identifying user to obtain access to solution |
48-48 |
No |
No |
|
2 |
SolutionToken |
English (United States) |
Valid solution token identifying solution the user will get access |
128-128 |
No |
No |
|
3 |
Duration |
English (United States) |
Maximum time interval (in seconds) user will be allowed to stay logged into solution |
1-8 |
No |
Yes |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario que recibirá acceso a una solución |
48-48 |
No |
No |
|
2 |
SolutionToken |
Español (moderno) |
Token de Solución válido identificando la solución a la cual el usuario tendrá acceso |
128-128 |
No |
No |
|
3 |
Duration |
Español (moderno) |
Intervalo máximo de tiempo (en segundos) que será permitido al usuario mantenerse conectado con la solución |
1-8 |
No |
Yes |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando usuário que receberá acesso a uma solução |
48-48 |
No |
No |
|
2 |
SolutionToken |
Português (Brasil) |
Token de Solução válido identificando a solução à qual o usuário terá acesso |
128-128 |
No |
No |
|
3 |
Duration |
Português (Brasil) |
Intervalo máximo de tempo (em segundos) que será permitido ao usuário se manter conectado com a solução |
1-8 |
No |
Yes |
Return Value
'SolutionLoginAllow' 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 'SolutionLoginAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Sol0000003 |
English (United States) |
Usage of specified solution is not allowed at this time |
:@Err#Sol0000008 |
English (United States) |
Solution Token type must be either M ('master') or Q ('query') |
:@Err#Sol0000011 |
English (United States) |
This solution is being upgraded for all its users |
:@Err#Sol0000012 |
English (United States) |
This solution is being upgraded for this user |
:@Err#Usr0000028 |
English (United States) |
User doesn't own the right to use the specified solution |
:@Err#Usr0000029 |
English (United States) |
User doesn't own the right to use the specified solution at this moment in time |
:@Err#Usr0000030 |
English (United States) |
User doesn't own the right to use the specified solution anymore because he was migrated to another one |
:@Err#Sol0000003 |
Español (moderno) |
El uso de la solución indicada no es permitido en este momento |
:@Err#Sol0000008 |
Español (moderno) |
Tipo de token de solución tiene que ser M ('master') o Q ('query') |
:@Err#Sol0000011 |
Español (moderno) |
Esta solución está siendo actualizada para todos los usuarios |
:@Err#Sol0000012 |
Español (moderno) |
Esta solución está siendo actualizada para este usuario |
:@Err#Usr0000028 |
Español (moderno) |
Usuario no posee el derecho de usar la solución especificada |
:@Err#Usr0000029 |
Español (moderno) |
Usuario no posee el derecho de usar la solución especificada en este instante de tiempo |
:@Err#Usr0000030 |
Español (moderno) |
Usuario ya no posee el derecho de usar la solución especificada porque ha sido migrado a otra solución |
:@Err#Sol0000003 |
Português (Brasil) |
Uso da solução especificada não é pertimido neste momento |
:@Err#Sol0000008 |
Português (Brasil) |
Tipo de token de solução tem que ser M ('master') ou Q ('query') |
:@Err#Sol0000011 |
Português (Brasil) |
Esta solução está sendo atualizada para todos os usuários |
:@Err#Sol0000012 |
Português (Brasil) |
Esta solução está sendo atualizada para este usuário |
:@Err#Usr0000028 |
Português (Brasil) |
Usuário não possui o direito de usar a solução especificada |
:@Err#Usr0000029 |
Português (Brasil) |
Usuário não possui o direito de usar a solução especificada neste momento do tempo |
:@Err#Usr0000030 |
Português (Brasil) |
Usuário já não possui o direito de usar a solução especificada porque foi migrado para outra solução |
US Patent Requested
