Description

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

Language

Documentation

English (United States)

Retrieves the date on which specific solution's user will have to migrate to another version

Español (moderno)

Recupera la fecha en que el usuario de la solución específica tendrá que migrar a otra versión

Português (Brasil)

Recupera a data em que o usuário da solução específica terá que migrar para outra versão

Parameters

The following table describes all of 'UserSolutionUpgradeStartGet''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

operationhandle

48-48

No

No

2

User

English (United States)

User whose specific per user upgrade date will be retrieved (if current login corresponds to a User having only US rights, then the information can be retrieved only for himself)

email

7-128

No

No

3

SolutionName

English (United States)

Valid solution token identifying the solution to be queried regarding the specific user's start date of its upgrade process

solution

8-32

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario que recibirá la información

operationhandle

48-48

No

No

2

User

Español (moderno)

Usuario para el cual solicita su fecha de actualización específica (si el login actual pertenece a un usuario que apenas posee derecho US, la información sólo puede ser obtenida para él mismo)

email

7-128

No

No

3

SolutionName

Español (moderno)

Token de Solución válido identificando la solución para la cual desea obtener la fecha inicial del proceso de actualización para un usuario específico

solution

8-32

No

No

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando usuário que receberá a informação

operationhandle

48-48

No

No

2

User

Português (Brasil)

Usuário para o qual solicita sua data de atualização específica (se o login atual pertence a um usuário que apenas possui direito US, a informação só pode ser obtida para ele mesmo)

email

7-128

No

No

3

SolutionName

Português (Brasil)

Token de Solução válido identificando a solução da qual deseja obter a data inicial do processo de atualização específico para um usuário

solution

8-32

No

No

Return Value

'UserSolutionUpgradeStartGet' returns a value of type timestamp (minimum length of returned values is 24 characters characters, while maximum length of returned values is 24 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 'UserSolutionUpgradeStartGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

Errorcode

Language

Description

:@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#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#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