VersaCloud API ′UserSolutionUpgradeAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests to modify a specific user of a specific solution to migrate to another solution
Español (moderno)	Las solicitudes de modificación de un usuario específico de una solución específica para migrar a otra solución
Português (Brasil)	Os pedidos para modificar um utilizador específico de uma solução específica para migrar para outra solução de

Parameters

The following table describes all of 'UserSolutionUpgradeAllow''s parameters, in every language available.

 

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow, identifying user

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

 

ID: 2 - Name: User

Language: English (United States)

Description: Specific user whose solution upgrade request is to be registered (if current login corresponds to a User having only US rights, then the request will be handled only if for himself and only to solution he is currently logged in)

Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No

 

ID: 3 - Name: SolutionToken

Language: English (United States)

Description: Token of solution whose user will be migrated (master or clone is acceptable)

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: Valid

Language: English (United States)

Description: Solution user's specific migration start date

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: Decayment

Language: English (United States)

Description: Solution's user's migration period (measured in days, maximum allowed 30 days)

Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: No

 

ID: 6 - Name: TargetSolutionToken

Language: English (United States)

Description: Solution token (master or clone) identifying solution's this specific user will have to migrate to

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

 

ID: 7 - Name: TargetURL

Language: English (United States)

Description: URL of new executable file (for download)

Type: url - Min-Max Length: 12-256 - Reentr Key Member: No - Optional: Yes

 

ID: 1 - Name: Login

Language: Español (moderno)

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

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

 

ID: 2 - Name: User

Language: Español (moderno)

Description: Usuario espécifico cuyo pedido de actualización de una solución debe ser registrado (si el login actual pertenece a un usuario que apenas posee derecho US, sólo puede solicitar la migración para él mismo y apenas para la solución que está conectado)

Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No

 

ID: 3 - Name: SolutionToken

Language: Español (moderno)

Description: Token de la solución específica cuyos usuarios serán migrados (master o clon son aceptados)

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: Valid

Language: Español (moderno)

Description: Fecha de inicio de la migración de este usuario específico de la solución

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: Decayment

Language: Español (moderno)

Description: Período de migración de este usuario específico de la solución (medido en días, máximo permitido 30 días)

Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: No

 

ID: 6 - Name: TargetSolutionToken

Language: Español (moderno)

Description: Token de la solución (principal o clon) identificando la solución para la cual este usuario específico deberá migrar

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

 

ID: 7 - Name: TargetURL

Language: Español (moderno)

Description: URL de nuevo archivo binario (para descarga)

Type: url - Min-Max Length: 12-256 - Reentr Key Member: No - Optional: Yes

 

ID: 1 - Name: Login

Language: Português (Brasil)

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

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

 

ID: 2 - Name: User

Language: Português (Brasil)

Description: Usuário específico cujo pedido de atualização de uma solução deve ser registrado (se o login atual pertence a um usuário que apenas possui direito US, só pode solicitar a migração para ele próprio e apenas para a solução que está conectado)

Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No

 

ID: 3 - Name: SolutionToken

Language: Português (Brasil)

Description: Token da solução cujos usuários serão migrados (master ou clone é aceito)

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: Valid

Language: Português (Brasil)

Description: Data de início da migração deste usuário específico da solução

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: Decayment

Language: Português (Brasil)

Description: Período de migração deste usuário específico da solução (medido em dias, máximo permitido 30 dias)

Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: No

 

ID: 6 - Name: TargetSolutionToken

Language: Português (Brasil)

Description: Token da solução (master ou clone) identificando a solução para a qual este usuário específico deverá migrar

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

 

ID: 7 - Name: TargetURL

Language: Português (Brasil)

Description: URL de novo arquivo executável (para download)

Type: url - Min-Max Length: 12-256 - Reentr Key Member: No - Optional: Yes

---

Return Value

'UserSolutionUpgradeAllow' 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 'UserSolutionUpgradeAllow' 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#Sol0000023	English (United States)	Solution upgrade process cannot be defined to start in the past
:@Err#Sol0000025	English (United States)	A solution's single user migration process cannot be defined to take more than thirty days
:@Err#Sol0000029	English (United States)	Solution's upgrade target cannot be the same as current solution neither the VersaCloud platform itself
:@Err#Usr0000028	English (United States)	User doesn't own the right to use the specified solution
:@Err#Sol0000008	Español (moderno)	Tipo de token de solución tiene que ser M ('master') o Q ('query')
:@Err#Sol0000023	Español (moderno)	Proceso de migración de la solución no puede ser definido para comenzar en el pasado
:@Err#Sol0000025	Español (moderno)	Proceso de migración de un usuario individual de la solución no puede ser definido para tardar más de treinta días
:@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#Usr0000028	Español (moderno)	Usuario no posee el derecho de usar la solución especificada
:@Err#Sol0000008	Português (Brasil)	Tipo de token de solução tem que ser M ('master') ou Q ('query')
:@Err#Sol0000023	Português (Brasil)	Processo de migração da solução não pode ser definido para iniciar no passado
:@Err#Sol0000025	Português (Brasil)	Processo de migração de um usuário individual da solução não pode ser definido para demorar mais de trinta dias
:@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
:@Err#Usr0000028	Português (Brasil)	Usuário não possui o direito de usar a solução especificada

US Patent Requested