VersaCloud API ′MethodParameterAddAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Adds a parameter to a method being defined (callable only between MethodAddAllow and MethodAddCommit)
Español (moderno)	Añade un parámetro a un método siendo definido (llamada válida sólo entre MethodAddAllow y MethodAddCommit)
Português (Brasil)	Adiciona um parâmetro a um método sendo definido (chamada válida somente entre MethodAddAllow e MethodAddCommit)

Parameters

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

 

ID: 1 - Name: MethodAddAllow

Language: English (United States)

Description: Operation handle returned from succesful call of MethodAddAllow

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

 

ID: 2 - Name: ID

Language: English (United States)

Description: Parameter's ID (a positive integer identifying this parameter uniquely among the method's parameters)

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

 

ID: 3 - Name: Name

Language: English (United States)

Description: Parameter's name

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

 

ID: 4 - Name: Type

Language: English (United States)

Description: Name of VersaCloud type the values to be used for parameter will correspond to

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

 

ID: 5 - Name: MinLen

Language: English (United States)

Description: Minimum length of values used for this parameter

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

 

ID: 6 - Name: MaxLen

Language: English (United States)

Description: Maximum length of values used for this parameter

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

 

ID: 7 - Name: OptionalValue

Language: English (United States)

Description: Signals if this parameter will be optional or compulsory

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

 

ID: 8 - Name: ReentrancyKeyMember

Language: English (United States)

Description: (false if omitted) Specifies if this parameter is part of method's 'reentrancy lock key'

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

 

ID: 9 - Name: DefaultValue

Language: English (United States)

Description: Standard value to be used for this parameter if omitted upon calls (applies only if parameter has been defined as optional)

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

 

ID: 1 - Name: MethodAddAllow

Language: Español (moderno)

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

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

 

ID: 2 - Name: ID

Language: Español (moderno)

Description: ID del parámetro (un entero positivo identificando este parámetro de forma única entre los parámetros del método)

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

 

ID: 3 - Name: Name

Language: Español (moderno)

Description: Nombre del parámetro

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

 

ID: 4 - Name: Type

Language: Español (moderno)

Description: Nombre del tipo VersaCloud al cual corresponderán los valores a ser usados para el parámetro

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

 

ID: 5 - Name: MinLen

Language: Español (moderno)

Description: Tamaño mínimo de los valores a ser usados para este parámetro

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

 

ID: 6 - Name: MaxLen

Language: Español (moderno)

Description: Tamaño máximo de los valores a ser usados para este parámetro

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

 

ID: 7 - Name: OptionalValue

Language: Español (moderno)

Description: Indica si este parámetro será opcional o obligatorio

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

 

ID: 8 - Name: ReentrancyKeyMember

Language: Español (moderno)

Description: (falso si omitido) Determina si este parámetro es parte de la 'llave de bloqueo de reentrancia'

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

 

ID: 9 - Name: DefaultValue

Language: Español (moderno)

Description: Valor stándard a ser utilizado para este parámetro cuando no informado en las llamadas (aplicable sólamente si el parámetro ha sido definido como optativo)

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

 

ID: 1 - Name: MethodAddAllow

Language: Português (Brasil)

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

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

 

ID: 2 - Name: ID

Language: Português (Brasil)

Description: ID do parâmetro (um inteiro positivo identificando este parâmetro de forma única entre os parâmetros do método)

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

 

ID: 3 - Name: Name

Language: Português (Brasil)

Description: Nome do parâmetro

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

 

ID: 4 - Name: Type

Language: Português (Brasil)

Description: Nome do tipo VersaCloud a qual corresponderão os valores a serem usados para o parâmetro

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

 

ID: 5 - Name: MinLen

Language: Português (Brasil)

Description: Comprimento mínimo dos valores a serem usados para este parâmetro

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

 

ID: 6 - Name: MaxLen

Language: Português (Brasil)

Description: Comprimento máximo dos valores a serem usados para este parâmetro

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

 

ID: 7 - Name: OptionalValue

Language: Português (Brasil)

Description: Sinaliza se este parâmetro será opciona ou obrigatório

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

 

ID: 8 - Name: ReentrancyKeyMember

Language: Português (Brasil)

Description: (falso se omitido) Especifica se este parâmetro é parte da 'chave de bloqueio de reentrancia'

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

 

ID: 9 - Name: DefaultValue

Language: Português (Brasil)

Description: Valor padrão a ser usado para este parâmetro quando omitido nas chamadas (aplica-se somente se o parâmetro tiver sido definido como opcional)

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

---

Return Value

'MethodParameterAddAllow' 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 'MethodParameterAddAllow' 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#Met0000021	English (United States)	Value provided as new parameter ID must be unique among all of method's parameters
:@Err#Met0000022	English (United States)	Value provided as new parameter name must be unique among all of method's parameters
:@Err#Met0000025	English (United States)	Specified ID has not been defined as a parameter for this query
:@Err#Met0000026	English (United States)	Method parameter's maximum length cannot be bigger than its type maximum allowed length
:@Err#Met0000027	English (United States)	Minimum length must be less or equal than maximum length of parameter's value
:@Err#Met0000028	English (United States)	Default value provided does not follow rules for parameter's type and/or length
:@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#Met0000021	Español (moderno)	Valor informado como nuevo ID del parámetro debe ser único entre todos los parámetros del método
:@Err#Met0000022	Español (moderno)	Valor informado como nombre del nuevo parámetro debe ser único entre todos los parámetros del método
:@Err#Met0000025	Español (moderno)	El ID especificado no fue definido como un parámetro para esta consulta
:@Err#Met0000026	Español (moderno)	El largo máximo del parámetro del método no puede ser mayor que el largo máximo del tipo del parámetro
:@Err#Met0000027	Español (moderno)	Largo mínimo debe ser menor o igual que el largo máximo del valor del parámetro
:@Err#Met0000028	Español (moderno)	Valor stándard informado no sigue las reglas para el tipo y/o el largo del tipo del parámetro
:@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#Met0000021	Português (Brasil)	Valor fornecido como novo ID do parâmetro deve ser único dentre todos os parâmetros do método
:@Err#Met0000022	Português (Brasil)	Valor fornecido como nome do novo parâmetro deve ser único dentre todos os parâmetros do método
:@Err#Met0000025	Português (Brasil)	O ID especificado não foi definido como um parâmetro para esta consulta
:@Err#Met0000026	Português (Brasil)	O comprimento máximo do parâmetro do método não pode ser maior que o comprimento máximo do tipo do parâmetro
:@Err#Met0000027	Português (Brasil)	Comprimento mínimo deve ser menor ou igual que o comprimento máximo do valor do parâmetro
:@Err#Met0000028	Português (Brasil)	Valor padrão informado não segue as regras para o tipo e/ou comprimento do tipo do parâmetro

US Patent Requested