Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'UserSolutionDecaymentGet' Reference Documentation
Description
The following table displays the documentation for the 'UserSolutionDecaymentGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves a specific solution's decayment time for a specific user (measured in days) |
Español (moderno) |
Recupera el tiempo decayment de una solución específica para un usuario específico (medido en días) |
Português (Brasil) |
Recupera tempo decayment uma solução específica para um usuário específico (medido em dias) |
Parameters
The following table describes all of 'UserSolutionDecaymentGet''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 the user retrieving information |
48-48 |
No |
No |
|
2 |
User |
English (United States) |
User whose specific per user solution's decayment time will be retrieved (if current login corresponds to a User having only US rights, then the information can be retrieved only for himself) |
7-128 |
No |
No |
|
3 |
Solution |
English (United States) |
Valid solution name identifying the user/solution to be queried regarding its decayment period |
8-32 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario que está buscando información |
48-48 |
No |
No |
|
2 |
User |
Español (moderno) |
Usuario para el cual solicita el período de decaimiento específico (si el login actual pertenece a un usuario que apenas posee derecho US, la información sólo puede ser obtenida para él mismo) |
7-128 |
No |
No |
|
3 |
Solution |
Español (moderno) |
Nombre de Solución válido identificando al usuario/solución para los cuales desea obtener el período de decaimiento |
8-32 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o usuário que está buscando a informação |
48-48 |
No |
No |
|
2 |
User |
Português (Brasil) |
Usuário para o qual solicita o período de decaimento específico dele (se o login atual pertence a um usuário que apenas possui direito US, a informação só pode ser obtida para ele mesmo) |
7-128 |
No |
No |
|
3 |
Solution |
Português (Brasil) |
Nome de Solução válido identificando o usuário/solução para os quais deseja obter o período de decaimento |
8-32 |
No |
No |
Return Value
'UserSolutionDecaymentGet' returns a value of type unsigned (minimum length of returned values is one character characters, while maximum length of returned values is 10 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 'UserSolutionDecaymentGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Sol0000005 |
English (United States) |
Token type must be either M (for 'master'), C (for 'clone'),Q (for 'query') |
:@Err#Sol0000021 |
English (United States) |
This solution's upgrade process, including a decayment period, a target solution and an optional URL, has not yet been defined (use SolutionUpgradeAllow/Commit to define it) |
:@Err#Usr0000024 |
English (United States) |
Specified user does not have the needed right to invoke this API |
:@Err#Usr0000028 |
English (United States) |
User doesn't own the right to use the specified solution |
:@Err#Sol0000005 |
Español (moderno) |
Tipo de token es obligatoriamente M (para 'máster'), C (para 'clon'), Q (para 'query') o B ('back-end') |
:@Err#Sol0000021 |
Español (moderno) |
El proceso de actualización de esta solución, incluyendo el período de decaimiento, una solución destino y un URL opcional, aún no ha sido definido (use SolutionUpgradeAllow/Commit para definirlo) |
:@Err#Usr0000024 |
Español (moderno) |
Usuario informado no tiene los derechos necesarios para llamar esta API |
:@Err#Usr0000028 |
Español (moderno) |
Usuario no posee el derecho de usar la solución especificada |
:@Err#Sol0000005 |
Português (Brasil) |
Tipo de token obrigatoriamente é M (para 'master'), C (para 'clone'), Q (para 'query') ou B ('back-end') |
:@Err#Sol0000021 |
Português (Brasil) |
O processo de atualização desta solução, incluindo um período de decaimento, uma solução alvo e uma URL opcional, ainda não foi definido (use SolutionUpgradeAllow/Commit para defini-lo) |
:@Err#Usr0000024 |
Português (Brasil) |
Usuário especificado não possui os direitos necessários para chamar esta API |
:@Err#Usr0000028 |
Português (Brasil) |
Usuário não possui o direito de usar a solução especificada |
US Patent Requested
