VersaCloud API ′CallbackValid′ Reference Documentation

Description

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

Parameters

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

ID: 1 - Name: SolutionToken

Language: English (United States)

Description: Valid solution token identifying solution the callback corresponds to (master or clone)

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

ID: 2 - Name: MethodName

Language: English (United States)

Description: Name of method to which callback should be associated

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

ID: 3 - Name: CallbackID

Language: English (United States)

Description: Callback ID to be verified if already used to assign a callback to specified method

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

ID: 4 - Name: Rollback

Language: English (United States)

Description: If not provided or True, instructs to lookup for an existing standard callback definition; if False, instructs to verify if specific ID has an associated rollback callback

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

ID: 1 - Name: SolutionToken

Language: Español (moderno)

Description: Token de solución válido identificando a la solución a la cual debe pertenecer el callback (máster o clon)

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

ID: 2 - Name: MethodName

Language: Español (moderno)

Description: Nombre del método al cual el callback debería estar asociado

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

ID: 3 - Name: CallbackID

Language: Español (moderno)

Description: ID del callback a ser validado como ya asociado a un callback del método indicado

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

ID: 4 - Name: Rollback

Language: Español (moderno)

Description: Si no informado o True, impone la verificación de existencia de un callback normal para el método; si False, impone la búsqueda por un callback de rollback

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

ID: 1 - Name: SolutionToken

Language: Português (Brasil)

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

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

ID: 2 - Name: MethodName

Language: Português (Brasil)

Description: Nome do método ao qual o callback deveria estar vinculado

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

ID: 3 - Name: CallbackID

Language: Português (Brasil)

Description: ID do callback a ser verificado como já vinculado a um callback para o método especificado

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

ID: 4 - Name: Rollback

Language: Português (Brasil)

Description: Se não fornecido ou True, implica na verificação da existência de um callback normal para o método; se False, implica na busca por um callback de rollback

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

---

Return Value

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

US Patent Requested