Description

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

Language

Documentation

English (United States)

Retrieves an existing solution's token

Español (moderno)

Recupera símbolo de una solución existente

Português (Brasil)

Recupera símbolo de uma solução existente

Parameters

The following table describes all of 'SolutionTokenGet''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 retrieving information

operationhandle

48-48

No

No

2

SolutionName

English (United States)

Name of solution to have its token retrieved

solution

8-32

No

No

3

Type

English (United States)

M ('Master'), C ('Clone'), Q ('Query') or T ('Translator')

solutiontokenType

1-1

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando el usuario que toma la información

operationhandle

48-48

No

No

2

SolutionName

Español (moderno)

Nombre de la solución cuyo token desea obtener

solution

8-32

No

No

3

Type

Español (moderno)

M ('Máster'), C ('Clon'), Q ('Query') o T ('Traductor')

solutiontokenType

1-1

No

No

1

Login

Português (Brasil)

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

operationhandle

48-48

No

No

2

SolutionName

Português (Brasil)

Nome da solução cujo token deseja obter

solution

8-32

No

No

3

Type

Português (Brasil)

M ('Master'), C ('Clone'), Q ('Query') ou T ('Tradutor')

solutiontokenType

1-1

No

No

Return Value

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

Errorcode

Language

Description

:@Err#Sol0000001

English (United States)

Value provided as Solution is not registered with VersaCloud

:@Err#Sol0000005

English (United States)

Token type must be either M (for 'master'), C (for 'clone'),Q (for 'query')

:@Err#Usr0000024

English (United States)

Specified user does not have the needed right to invoke this API

:@Err#Sol0000001

Español (moderno)

Valor informado como Solución no está registrado en VersaCloud

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

Español (moderno)

Usuario informado no tiene los derechos necesarios para llamar esta API

:@Err#Sol0000001

Português (Brasil)

Valor informado como Solução não está registrado em VersaCloud

:@Err#Sol0000005

Português (Brasil)

Tipo de token obrigatoriamente é M (para 'master'), C (para 'clone'), Q (para 'query') ou B ('back-end')

:@Err#Usr0000024

Português (Brasil)

Usuário especificado não possui os direitos necessários para chamar esta API

US Patent Requested