VersaCloud API ′QueryParameterAddAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests defining a query parameter (name in brackets specify its usage)
Español (moderno)	Solicita la definición de un parámetro de consulta (nombre entre llaves especifica su uso)
Português (Brasil)	Solicita a definição de um parâmetro de consulta (nome entre chaves especifica seu uso)

Parameters

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

 

ID: 1 - Name: QueryAddAllow

Language: English (United States)

Description: Operation handle returned from succesful call of QueryAddAllow

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 query'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: 1-16 - 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: 1 - Name: QueryAddAllow

Language: Español (moderno)

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

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 de la consulta)

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: 1-16 - 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: 1 - Name: QueryAddAllow

Language: Português (Brasil)

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

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 da consulta)

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: 1-16 - 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

---

Return Value

'QueryParameterAddAllow' 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 'QueryParameterAddAllow' 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#Qry0000015	English (United States)	It is not allowed to add a new parameter to a query using a repeated ID value
:@Err#Qry0000016	English (United States)	It is not allowed to add a new parameter to a query using a repeated parameter name
:@Err#Qry0000017	English (United States)	An existing parameter Name cannot be associated to a second parameter ID
:@Err#Qry0000019	English (United States)	Parameter ID being added must be unique among all existing and new parameters being defined
:@Err#Qry0000020	English (United States)	New parameter name must be unique among parameters being added
:@Err#Qry0000025	English (United States)	Query parameter's minimum length cannot be smaller than its type minimum allowed length
:@Err#Qry0000026	English (United States)	Query parameter's maximum length cannot be bigger than its type maximum allowed length
:@Err#Qry0000027	English (United States)	Minimum length must be less or equal than maximum length of parameter's value
:@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#Qry0000015	Español (moderno)	No es permitido añadir un nuevo parámetro a una consulta usando un valor de ID repetido
:@Err#Qry0000016	Español (moderno)	No es permitido añadir un nuevo parámetro a una consulta usando un nombre de parámetro repetido
:@Err#Qry0000017	Español (moderno)	Un nombre de parámetro ya existente no puede ser asociado a un segundo ID de parámetro
:@Err#Qry0000019	Español (moderno)	ID de parámetro siendo añadido tiene que ser único entre todos los IDs de parámetros ya existentes y los nuevos siendo definidos
:@Err#Qry0000020	Español (moderno)	Nuevo nombre de parámetro debe ser único entre los parámetros siendo añadidos
:@Err#Qry0000025	Español (moderno)	El largo mínimo del parámetro de la consulta no puede ser menor que el largo mínimo del tipo del parámetro
:@Err#Qry0000026	Español (moderno)	El largo máximo del parámetro de la consulta no puede ser mayor que el largo máximo del tipo del parámetro
:@Err#Qry0000027	Español (moderno)	Largo mínimo debe ser menor o igual que el largo máximo del valor 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#Qry0000015	Português (Brasil)	Não é permitido adicionar um novo parâmetro a uma consulta usando um valor de ID repetido
:@Err#Qry0000016	Português (Brasil)	Não é permitido adicionar um novo parâmetro a uma consulta usando um nome de parâmetro repetido
:@Err#Qry0000017	Português (Brasil)	Um nome de parâmetro já existente não pode ser associado a um segundo ID de parâmetro
:@Err#Qry0000019	Português (Brasil)	ID de parâmetro sendo adicionado tem que ser único entre todos os IDs de parâmetros já existentes e os novos sendo definidos
:@Err#Qry0000020	Português (Brasil)	Novo nome de parâmetro deve ser único entre os parâmetros sendo adicionados
:@Err#Qry0000025	Português (Brasil)	O comprimento mínimo do parâmetro da consulta não pode ser menor que o comprimento mínimo do tipo do parâmetro
:@Err#Qry0000026	Português (Brasil)	O comprimento máximo do parâmetro da consulta não pode ser maior que o comprimento máximo do tipo do parâmetro
:@Err#Qry0000027	Português (Brasil)	Comprimento mínimo deve ser menor ou igual que o comprimento máximo do valor do parâmetro

US Patent Requested