VersaCloud API ′CallbackParameterAddAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Adds parameters to a specific callback (identified by the parameter IDs of the method the callback belongs to)
Español (moderno)	Añade parámetros a un callback específico (identificados pelos IDs dos parámetros del método al cual el callback pertence)
Português (Brasil)	Adiciona parâmetros a um callback específico (identificados pelos IDs dos parâmetros do método ao qual o callback pertence)

Parameters

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

 

ID: 1 - Name: CallbackAddAllow

Language: English (United States)

Description: Operation handle returned from succesful call of CallbackAddAllow

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

 

ID: 2 - Name: MethodParameterID01

Language: English (United States)

Description: ID of method's parameter whose value is to be passed on to callback

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

 

ID: 3 - Name: MethodParameterID02

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 4 - Name: MethodParameterID03

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 5 - Name: MethodParameterID04

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 6 - Name: MethodParameterID05

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 7 - Name: MethodParameterID06

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 8 - Name: MethodParameterID07

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 9 - Name: MethodParameterID08

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 10 - Name: MethodParameterID09

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 11 - Name: MethodParameterID10

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 12 - Name: MethodParameterID11

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 13 - Name: MethodParameterID12

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 14 - Name: MethodParameterID13

Language: English (United States)

Description: Additional ID of method's parameter whose value is to be passed on to callback

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

 

ID: 1 - Name: CallbackAddAllow

Language: Español (moderno)

Description: Protocolo de operación obtenido de llamada exitosa a CallbackAddAllow

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

 

ID: 2 - Name: MethodParameterID01

Language: Español (moderno)

Description: ID del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 3 - Name: MethodParameterID02

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 4 - Name: MethodParameterID03

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 5 - Name: MethodParameterID04

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 6 - Name: MethodParameterID05

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 7 - Name: MethodParameterID06

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 8 - Name: MethodParameterID07

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 9 - Name: MethodParameterID08

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 10 - Name: MethodParameterID09

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 11 - Name: MethodParameterID10

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 12 - Name: MethodParameterID11

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 13 - Name: MethodParameterID12

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 14 - Name: MethodParameterID13

Language: Español (moderno)

Description: ID adicional del parámetro del método cuyo valor debe ser pasado para el callback

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

 

ID: 1 - Name: CallbackAddAllow

Language: Português (Brasil)

Description: Protocolo de operação retornado por chamada bem sucedida a CallbackAddAllow

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

 

ID: 2 - Name: MethodParameterID01

Language: Português (Brasil)

Description: ID do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 3 - Name: MethodParameterID02

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 4 - Name: MethodParameterID03

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 5 - Name: MethodParameterID04

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 6 - Name: MethodParameterID05

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 7 - Name: MethodParameterID06

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 8 - Name: MethodParameterID07

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 9 - Name: MethodParameterID08

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 10 - Name: MethodParameterID09

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 11 - Name: MethodParameterID10

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 12 - Name: MethodParameterID11

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 13 - Name: MethodParameterID12

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

 

ID: 14 - Name: MethodParameterID13

Language: Português (Brasil)

Description: ID adicional do parâmetro do método cujo valor deve ser passado para o callback

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

---

Return Value

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

Errorcode	Language	Description
:@Err#Api0000031	English (United States)	Operation handle was not returned by a previous corresponding and still pending ...Allow call
:@Err#Cbk0000015	English (United States)	Callback's parameter set contains at least one parameter more than once
:@Err#Prm0000004	English (United States)	Parameter ID provided has not been defined for this method
:@Err#Api0000031	Español (moderno)	Protocolo de operación no fue obtenido por uma llamada anterior a ...Allow correspondiente y que aún está pendiente
:@Err#Cbk0000015	Español (moderno)	Conjunto de parámetros del callback contiene por lo menos un parámetro más de una vez
:@Err#Prm0000004	Español (moderno)	ID de parámetro indicado no fue definido para este método
:@Err#Api0000031	Português (Brasil)	Protocolo de operação não foi retornado por uma chamada prévia ao ...Allow correspondente e que ainda está pendente
:@Err#Cbk0000015	Português (Brasil)	Conjunto de parâmetros do callback contém ao menos um parâmetro mais de uma vez
:@Err#Prm0000004	Português (Brasil)	ID de parâmetro fornecido não foi definido para este método

US Patent Requested