VersaCloud API ′CallbackAddAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests to add a new (or modify an existing) callback for a specific method already defined on VersaCloud
Español (moderno)	Solicita añadir un nuevo (o alterar un existente) callback para un método específico ya definido en VersaCloud
Português (Brasil)	Solicita adicionar um novo (ou modificar um existente) callback para um método específico já definido em VersaCloud

Parameters

The following table describes all of 'CallbackAddAllow''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: Master solution token identifying solution the method being modified belongs to

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

 

ID: 3 - Name: MethodName

Language: English (United States)

Description: Name of method to have a callback added

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

 

ID: 4 - Name: CallbackID

Language: English (United States)

Description: Callback's ID (a positive integer identifying this callback uniquely among the method's callbacks - shared by rollback callbacks with their corresponding standard callback)

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

 

ID: 5 - Name: CallbackName

Language: English (United States)

Description: Name used to identify this (new) callback (must be unique among all method's callback)

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

 

ID: 6 - Name: ReturnType

Language: English (United States)

Description: VersaCloud type of return value (will be ignored for assynchronous callbacks)

Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No

 

ID: 7 - Name: Protocol

Language: English (United States)

Description: Name of connection type to be used by VersaCloud to call into callback (e.g. OLEDB or WebService)

Type: string - Min-Max Length: 3-64 - Reentr Key Member: No - Optional: No

 

ID: 8 - Name: ProtocolParameter1

Language: English (United States)

Description: First part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID])

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

 

ID: 9 - Name: Synchronous

Language: English (United States)

Description: If True, callback is synchronous (VersaCloud waits for return value); if False, callback is assynchronous (upon call, a separate process will be spawned)

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

 

ID: 10 - Name: ProtocolParameter2

Language: English (United States)

Description: Second part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID])

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

 

ID: 11 - Name: ProtocolParameter3

Language: English (United States)

Description: Third part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID])

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

 

ID: 12 - Name: ProtocolParameter4

Language: English (United States)

Description: Fourth part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID])

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

 

ID: 13 - Name: ProtocolParameter5

Language: English (United States)

Description: Fifth part of strings needed with specified protocol (VersaCloud methods' parameters can be referenced by number as [%ID])

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

 

ID: 14 - Name: Rollback

Language: English (United States)

Description: (default value is False) If True, instructs VersaCloud to call this callback only during automatic rollback; if False, callback is standard part of method's invocation

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 máster de solución identificando la solución a la cual pertenece el método siendo modificado

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

 

ID: 3 - Name: MethodName

Language: Español (moderno)

Description: Nombre del método que tendrá un callback añadido

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

 

ID: 4 - Name: CallbackID

Language: Español (moderno)

Description: ID del callback (un entero positivo identificando este callback de forma única entre los callbacks del método - compartido por callbacks de rollback con su correspondiente callback normal)

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

 

ID: 5 - Name: CallbackName

Language: Español (moderno)

Description: Nombre usado para identificar este (novo) callback (debe ser único entre todos los callbacks del método)

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

 

ID: 6 - Name: ReturnType

Language: Español (moderno)

Description: Tipo VersaCloud del valor de retorno (será ignorado para callbacks asincrónicos)

Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No

 

ID: 7 - Name: Protocol

Language: Español (moderno)

Description: Nombre del tipo de conexión a ser utilizada por VersaCloud para la llamada del callback (p.ej. OLEDB o WebService)

Type: string - Min-Max Length: 3-64 - Reentr Key Member: No - Optional: No

 

ID: 8 - Name: ProtocolParameter1

Language: Español (moderno)

Description: Primera parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID])

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

 

ID: 9 - Name: Synchronous

Language: Español (moderno)

Description: Se True, callback es sincrónico (VersaCloud espera por el valor de retorno); se False, callback es asincrónico (cuando acionado, es ejecutado como un proceso independiente)

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

 

ID: 10 - Name: ProtocolParameter2

Language: Español (moderno)

Description: Segunda parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID])

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

 

ID: 11 - Name: ProtocolParameter3

Language: Español (moderno)

Description: Tercera parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID])

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

 

ID: 12 - Name: ProtocolParameter4

Language: Español (moderno)

Description: Cuarta parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID])

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

 

ID: 13 - Name: ProtocolParameter5

Language: Español (moderno)

Description: Quinta parte de las secuencias de caracteres necesarias con el protocolo especificado (parámetros de los métodos VersaCloud pueden ser referenciados como [%ID])

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

 

ID: 14 - Name: Rollback

Language: Español (moderno)

Description: (valor standard es Falso) Si True, especifica VersaCloud a llamar este callback solamente durante rollbacks automáticos; si False, callback es parte normal de la llamada del método

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 master de solução identificando a solução à qual pertence o método sendo modificado

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

 

ID: 3 - Name: MethodName

Language: Português (Brasil)

Description: Nome do método que terá um callback adicionado

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

 

ID: 4 - Name: CallbackID

Language: Português (Brasil)

Description: ID do callback (um inteiro positivo identificando este callback de forma única entre os callbacks do método - compartilhado pelos callbacks de rollback com seu correspondente callback normal)

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

 

ID: 5 - Name: CallbackName

Language: Português (Brasil)

Description: Nome usado para identificar este (novo) callback (deve ser único entre todos os callbacks do método)

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

 

ID: 6 - Name: ReturnType

Language: Português (Brasil)

Description: Tipo VersaCloud do valor de retorno (será ignorado para callbacks assíncronos)

Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No

 

ID: 7 - Name: Protocol

Language: Português (Brasil)

Description: Nome do tipo de conexão a ser usado por VersaCloud para a chamada do callback (p.ex. OLEDB ou WebService)

Type: string - Min-Max Length: 3-64 - Reentr Key Member: No - Optional: No

 

ID: 8 - Name: ProtocolParameter1

Language: Português (Brasil)

Description: Primeira parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID])

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

 

ID: 9 - Name: Synchronous

Language: Português (Brasil)

Description: Se True, callback é síncrono (VersaCloud aguarda pelo valor de retorno); se False, callback é assíncrono (quando acionado, é executado como um processo independente)

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

 

ID: 10 - Name: ProtocolParameter2

Language: Português (Brasil)

Description: Segunda parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID])

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

 

ID: 11 - Name: ProtocolParameter3

Language: Português (Brasil)

Description: Terceira parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID])

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

 

ID: 12 - Name: ProtocolParameter4

Language: Português (Brasil)

Description: Quarta parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID])

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

 

ID: 13 - Name: ProtocolParameter5

Language: Português (Brasil)

Description: Quinta parte das sequencias de caracteres necessárias com o protocolo especificado (parâmetros dos métodos VersaCloud podem ser referenciados como [%ID])

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

 

ID: 14 - Name: Rollback

Language: Português (Brasil)

Description: (valor padrão é False) Se True, especifica a VersaCloud para chamar este callback somente durante rollbacks automáticos; se False, callback é parte normal da chamada do método

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

---

Return Value

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

Errorcode	Language	Description
:@Err#Cbk0000011	English (United States)	Value provided as new callback name is already in use with specified method
:@Err#Cbk0000013	English (United States)	Value provided as new callback ID is already in use with specified method
:@Err#Cbk0000999	English (United States)	Value provided as callback invocation protocol has not been implemented
:@Err#Met0000011	English (United States)	Value provided as method name is not part of specified Solution
:@Err#Met0000911	English (United States)	A method's definition cannot be modified while there are active transactions created as instance of this same method
:@Err#Sol0000006	English (United States)	Solution Token is not valid
:@Err#Cbk0000011	Español (moderno)	Valor informado como nuevo nombre de callback ya está en uso con el método especificado
:@Err#Cbk0000013	Español (moderno)	Valor informado como nuevo ID de callback ya está en uso con el método especificado
:@Err#Cbk0000999	Español (moderno)	Valor informado como protocolo de llamada callback no está implementado
:@Err#Met0000011	Español (moderno)	Valor informado como nombre de método no es parte de la solución indicada
:@Err#Met0000911	Español (moderno)	La definición de un método no puede ser cambiada mientras haya transacciones activas e instanciadas a partir del método en cuestión
:@Err#Sol0000006	Español (moderno)	Token de solución no es válido
:@Err#Cbk0000011	Português (Brasil)	Valor fornecido como novo nome de callback já está em uso com o método especificado
:@Err#Cbk0000013	Português (Brasil)	Valor fornecido como novo ID de callback já está em uso com o método especificado
:@Err#Cbk0000999	Português (Brasil)	Valor fornecido como protocolo de chamada de callback não está implementado
:@Err#Met0000011	Português (Brasil)	Valor informado como nome de método não é parte da solução especificada
:@Err#Met0000911	Português (Brasil)	A definição de um método não pode ser modificada enquanto houver transações ativas e instanciadas a partir do método em questão
:@Err#Sol0000006	Português (Brasil)	Token de solução não é válido

US Patent Requested