Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'Valid' Reference Documentation
Description
The following table displays the documentation for the 'Valid' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Verifies if given string is a value following the rules of a specific simple type |
Español (moderno) |
Verifica si una dada secuencia de caracteres es un valor que atiende a las reglas de un tipo simple específico |
Português (Brasil) |
Verifica se uma dada sequencia de caracteres é um valor que segue as regras de um tipo simples específico |
Parameters
The following table describes all of 'Valid''s parameters, in every language available.
ID |
Name |
Language |
Description |
Type |
Min-Max Length |
Reentr Key Member |
Optional |
|---|---|---|---|---|---|---|---|
1 |
Typename |
English (United States) |
Name of type whose rules will be used to test if the second parameter's value is valid |
3-24 |
No |
No |
|
2 |
Value |
English (United States) |
String whose contents are to be verified as a valid value of type defined by first parameter |
1-256 |
No |
No |
|
1 |
Typename |
Español (moderno) |
Nombre del tipo cuyas reglas serán usadas para testear si el valor del segundo parámetro es válido |
3-24 |
No |
No |
|
2 |
Value |
Español (moderno) |
Secuencia de caracteres cuyo contenido será validado como valor correcto del tipo definido pelo primero parámetro |
1-256 |
No |
No |
|
1 |
Typename |
Português (Brasil) |
Nome do tipo cujas regras serão usadas para testar se o valor do segundo parâmetro é válido |
3-24 |
No |
No |
|
2 |
Value |
Português (Brasil) |
Sequencia de caracteres cujo conteúdo será verificado como valor válido do tipo definido pelo primeiro parâmetro |
1-256 |
No |
No |
Return Value
'Valid' 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 'Valid' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Vld0009025 |
English (United States) |
Valid does not support requests for this type for security or performance reasons; please use other VersaCloud APIs for this purpose |
:@Err#Vld0009025 |
Español (moderno) |
Valid no brinda soporte para pedidos baseados em este tipo por razones de seguridad o performance; por favor use otras APIs de VersaCloud para esta finalidad |
:@Err#Vld0009025 |
Português (Brasil) |
Valid não fornece suporte para solicitações baseadas neste tipo por razões de segurança ou performance; por favor use outras APIs de VersaCloud para esta finalidade |
US Patent Requested
