VersaCloud API ′CallbackUntilSetAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests to set a new maximum date for callback usage
Español (moderno)	Las solicitudes para establecer una nueva fecha máxima para el uso de devolución de llamada
Português (Brasil)	Solicitações para definir uma nova data máxima para uso de callback

Parameters

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

 

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow, identifying developer responsible for time limitation

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

 

ID: 2 - Name: SolutionToken

Language: English (United States)

Description: Valid master solution token identifying solution the callback corresponds to

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 the callback belongs to

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

 

ID: 4 - Name: ID

Language: English (United States)

Description: ID of callback whose calls are being limited in time

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

 

ID: 5 - Name: Until

Language: English (United States)

Description: Maximum date at which VersaCloud will still call into the callback specified

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

 

ID: 6 - Name: Rollback

Language: English (United States)

Description: If True, instructs VersaCloud to modify final date for a rollback callback; if False or not provided, final date for standard callback will be modified

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 obtenido de llamada exitosa a UserLoginAllow, identificando al desarrollador responsable por la limitación en el tiempo

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 válido identificando a la solución a la cual debe pertenecer el callback

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 al cual pertenece el callback

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

 

ID: 4 - Name: ID

Language: Español (moderno)

Description: ID del callback cuyas llamadas están siendo limitadas en el tempo

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

 

ID: 5 - Name: Until

Language: Español (moderno)

Description: Fecha máxima en la que VersaCloud aún efectuará llamadas del callback indicado

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

 

ID: 6 - Name: Rollback

Language: Español (moderno)

Description: Si True, solicita a VersaCloud que cambie la fecha final para un callback de rollback; si False o no informado, será cambiada la fecha final 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 retornado por chamada bem sucedida a UserLoginAllow, identificando desenvolvedor responsável pela limitação no tempo

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 válido identificando a solução à qual o callback pertence

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 ao qual o callback pertence

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

 

ID: 4 - Name: ID

Language: Português (Brasil)

Description: ID do callback cujas chamadas estão sendo limitado no tempo

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

 

ID: 5 - Name: Until

Language: Português (Brasil)

Description: Data máxima na qual VersaCloud ainda efetuará chamadas ao callback especificado

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

 

ID: 6 - Name: Rollback

Language: Português (Brasil)

Description: Se True, solicita que VersaCloud modifique a data final para um callback de rollback; se False ou não informado, é modificada a data final para um callback normal.

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

---

Return Value

'CallbackUntilSetAllow' 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 'CallbackUntilSetAllow' 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#Met0000011	English (United States)	Value provided as method name is not part of specified Solution
:@Err#Sol0000006	English (United States)	Solution Token is not valid
:@Err#Tim0000005	English (United States)	Maximum date/time allowed cannot be further into the past than the minimum date/time allowed
:@Err#Cbk0000014	Español (moderno)	Valor informado como nuevo ID de callback no está asociado al método especificado
:@Err#Met0000011	Español (moderno)	Valor informado como nombre de método no es parte de la solución indicada
:@Err#Sol0000006	Español (moderno)	Token de solución no es válido
:@Err#Tim0000005	Español (moderno)	Fecha/hora máxima permitida no puede estar más em el pasado que la fecha/hora mínima permitida
:@Err#Cbk0000014	Português (Brasil)	Valor fornecido como ID de callback não está associado com o método especificado
:@Err#Met0000011	Português (Brasil)	Valor informado como nome de método não é parte da solução especificada
:@Err#Sol0000006	Português (Brasil)	Token de solução não é válido
:@Err#Tim0000005	Português (Brasil)	Data/hora máxima permitida não pode estar mais no passado que a data/hora mínima permitida

US Patent Requested