VersaCloud API ′CallbackInfoGet′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Retrieves the name used to identify a specific callback
Español (moderno)	Obtiene el nombre usado para identificar un callback específico
Português (Brasil)	Obtém o nome usado para identificar um callback específico

Parameters

The following table describes all of 'CallbackInfoGet''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: SolutionToken

Language: English (United States)

Description: Valid solution token identifying solution the callback being queried belongs to (master or clone)

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

 

ID: 3 - Name: MethodName

Language: English (United States)

Description: Name of method whose callback is being queried

Type: method - Min-Max Length: 6-64 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: CallbackID

Language: English (United States)

Description: ID of callback being queried

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

 

ID: 5 - Name: Information

Language: English (United States)

Description: Type of information being retrieved (valid names are CallbackAddAllow's parameter names)

Type: string - Min-Max Length: 1-256 - Reentr Key Member: No - Optional: No

 

ID: 6 - Name: Rollback

Language: English (United States)

Description: If True, instructs VersaCloud to retrieve information about a rollback callback; if False or not provided, a standard callback' information will be retrieved

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: Yes

 

ID: 1 - Name: Login

Language: Español (moderno)

Description: Protocolo de operación resultante de llamada exitosa a UserLoginAllow, identificando al usuario

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

 

ID: 2 - Name: SolutionToken

Language: Español (moderno)

Description: Token de Solución válido identificando la solución a la cual pertenece el callback sobre el cual se está buscando información (máster o clon)

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

 

ID: 3 - Name: MethodName

Language: Español (moderno)

Description: Nombre del método de cuyo callback se está buscando información

Type: method - Min-Max Length: 6-64 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: CallbackID

Language: Español (moderno)

Description: ID del callback cuyo información está siendo buscada

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

 

ID: 5 - Name: Information

Language: Español (moderno)

Description: Tipo de información siendo buscada (nombres válidos son los nombres de los parámetros de CallbackAddAllow)

Type: string - Min-Max Length: 1-256 - Reentr Key Member: No - Optional: No

 

ID: 6 - Name: Rollback

Language: Español (moderno)

Description: Si True, solicita a VersaCloud que obtenga información de un callback de rollback; si False o no informado, se obtiene información de un callback stándard.

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: Yes

 

ID: 1 - Name: Login

Language: Português (Brasil)

Description: Protocolo de operação resultante de chamada bem sucedida a UserLoginAllow, identificando o usuário

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

 

ID: 2 - Name: SolutionToken

Language: Português (Brasil)

Description: Token de Solução válido identificando a solução à qual pertence o callback do qual busca informação (master ou clone)

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

 

ID: 3 - Name: MethodName

Language: Português (Brasil)

Description: Nome do método de cujo callback busca informação

Type: method - Min-Max Length: 6-64 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: CallbackID

Language: Português (Brasil)

Description: ID do callback do qual se está buscando informação

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

 

ID: 5 - Name: Information

Language: Português (Brasil)

Description: Tipo de informação sendo buscada (nomes válidos são os nomes dos parâmetros de CallbackAddAllow)

Type: string - Min-Max Length: 1-256 - Reentr Key Member: No - Optional: No

 

ID: 6 - Name: Rollback

Language: Português (Brasil)

Description: Se True, solicita que VersaCloud obtenha informação sobre um callback de rollback; se False ou não informado, obtem-se informação de um callback normal.

Type: boolean - Min-Max Length: 4-5 - Reentr Key Member: No - Optional: Yes

---

Return Value

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

Errorcode	Language	Description
:@Err#Cbk0000014	English (United States)	Value provided as callback ID is not associated to specified method
:@Err#Cbk0000017	English (United States)	Callback info type requested does not exist (choose among 'CallbackID', 'CallbackName', 'ReturnType', 'Protocol', 'ProtocolParameter1', 'ProtocolParameter2', 'ProtocolParameter3', 'ProtocolParameter4', 'ProtocolParameter5', 'Synchronous' or 'Rollback')
:@Err#Met0000011	English (United States)	Value provided as method name is not part of specified Solution
:@Err#Cbk0000014	Español (moderno)	Valor informado como nuevo ID de callback no está asociado al método especificado
:@Err#Cbk0000017	Español (moderno)	Tipo de información pedida de callback no existe (elija entre 'CallbackID', 'CallbackName', 'ReturnType', 'Protocol', 'ProtocolParameter1', 'ProtocolParameter2', 'ProtocolParameter3', 'ProtocolParameter4', 'ProtocolParameter5', 'Synchronous' o 'Rollback')
:@Err#Met0000011	Español (moderno)	Valor informado como nombre de método no es parte de la solución indicada
:@Err#Cbk0000014	Português (Brasil)	Valor fornecido como ID de callback não está associado com o método especificado
:@Err#Cbk0000017	Português (Brasil)	Tipo de informação de callback inexistente (escolha entre 'CallbackID', 'CallbackName', 'ReturnType', 'Protocol', 'ProtocolParameter1', 'ProtocolParameter2', 'ProtocolParameter3', 'ProtocolParameter4', 'ProtocolParameter5', 'Synchronous' ou 'Rollback')
:@Err#Met0000011	Português (Brasil)	Valor informado como nome de método não é parte da solução especificada

US Patent Requested