Description

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

Language

Documentation

English (United States)

Requests to upgrade all users of a specific solution to another one

Español (moderno)

Solicita que todos los usuarios de una solución específica sean migrados para otra solución

Português (Brasil)

Solicita que todos os usuários de uma solução específica sejam migrados para outra solução

Parameters

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

SolutionToken

English (United States)

Master token of solution whose users will be migrated

solutiontoken

128-128

No

No

3

UpgradeStart

English (United States)

Solution users' migration start date

timestamp

10-24

No

No

4

Decayment

English (United States)

Solution's users' migration period (measured in days, maximum allowed 1825 days)

unsigned

1-4

No

No

5

TargetSolutionToken

English (United States)

Solution token (master or clone) identifying solution's users will have to migrate to

solutiontoken

128-128

No

No

6

TargetURL

English (United States)

URL of new executable file (for download)

url

12-256

No

Yes

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

SolutionToken

Español (moderno)

Token 'master' de la solución específica cuyos usuarios serán migrados

solutiontoken

128-128

No

No

3

UpgradeStart

Español (moderno)

Fecha de inicio de la migración de los usuarios de la solución

timestamp

10-24

No

No

4

Decayment

Español (moderno)

Período de migración de los usuarios de la solución (medido en días, máximo permitido 1825 días)

unsigned

1-4

No

No

5

TargetSolutionToken

Español (moderno)

Token de la solución (principal o clon) identificando la solución para la cual los usuarios deberán migrar

solutiontoken

128-128

No

No

6

TargetURL

Español (moderno)

URL de nuevo archivo binario (para descarga)

url

12-256

No

Yes

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

SolutionToken

Português (Brasil)

Token 'mestre' da solução cujos usuários serão migrados

solutiontoken

128-128

No

No

3

UpgradeStart

Português (Brasil)

Data de início da migração dos usuários da solução

timestamp

10-24

No

No

4

Decayment

Português (Brasil)

Período de migração dos usuários da solução (medido em dias, máximo permitido 1825 dias)

unsigned

1-4

No

No

5

TargetSolutionToken

Português (Brasil)

Token da solução (master ou clone) identificando a solução para a qual os usuários deverão migrar

solutiontoken

128-128

No

No

6

TargetURL

Português (Brasil)

URL de novo arquivo executável (para download)

url

12-256

No

Yes

Return Value

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

Errorcode

Language

Description

:@Err#Sol0000006

English (United States)

Solution Token is not valid

:@Err#Sol0000023

English (United States)

Solution upgrade process cannot be defined to start in the past

:@Err#Sol0000029

English (United States)

Solution's upgrade target cannot be the same as current solution neither the VersaCloud platform itself

:@Err#Sol0000006

Español (moderno)

Token de solución no es válido

:@Err#Sol0000023

Español (moderno)

Proceso de migración de la solución no puede ser definido para comenzar en el pasado

:@Err#Sol0000029

Español (moderno)

Destino de la actualización de la solución no puede ser la solución actual ni la propria plataforma VersaCloud

:@Err#Sol0000006

Português (Brasil)

Token de solução não é válido

:@Err#Sol0000023

Português (Brasil)

Processo de migração da solução não pode ser definido para iniciar no passado

:@Err#Sol0000029

Português (Brasil)

Destino da atualização da solução não pode ser a solução atual nem a própria plataforma VersaCloud

US Patent Requested