VersaCloud API ′PropertyValid′ Reference Documentation

Description

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

Parameters

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

ID: 1 - Name: SolutionName

Language: English (United States)

Description: String containing the name of the solution the property belongs to

Type: solution - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No

ID: 2 - Name: PropertyCategoryName

Language: English (United States)

Description: String containing the property category the property to be checked belongs to

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

ID: 3 - Name: PropertyGroupName

Language: English (United States)

Description: String containing the property group the property to be checked belongs to

Type: propertygroup - Min-Max Length: 4-64 - Reentr Key Member: No - Optional: No

ID: 4 - Name: PropertyName

Language: English (United States)

Description: String to be verified if valid as the name of a property

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

ID: 1 - Name: SolutionName

Language: Español (moderno)

Description: Secuencia de carácteres conteniendo el nombre de la solución a la que pertenece la propriedad

Type: solution - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No

ID: 2 - Name: PropertyCategoryName

Language: Español (moderno)

Description: Secuencia de carácteres conteniendo el nombre de la categoría de propriedades a la cual la propriedad siendo validada debería pertenecer

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

ID: 3 - Name: PropertyGroupName

Language: Español (moderno)

Description: Secuencia de carácteres conteniendo el nombre del grupo de propriedades a la cual la propriedad siendo validada debería pertenecer

Type: propertygroup - Min-Max Length: 4-64 - Reentr Key Member: No - Optional: No

ID: 4 - Name: PropertyName

Language: Español (moderno)

Description: Secuencia de caracteres a ser verificada como siendo el nombre válido de una propriedad

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

ID: 1 - Name: SolutionName

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o nome da solução à qual a propriedade pertence

Type: solution - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No

ID: 2 - Name: PropertyCategoryName

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o nome da categoria de propriedades a qual a propriedade a ser verificada deveria pertencer

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

ID: 3 - Name: PropertyGroupName

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o nome do grupo de propriedades a qual a propriedade a ser verificada deveria pertencer

Type: propertygroup - Min-Max Length: 4-64 - Reentr Key Member: No - Optional: No

ID: 4 - Name: PropertyName

Language: Português (Brasil)

Description: Sequencia de caracteres a ser verificada como sendo o nome válido de uma propriedade

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

---

Return Value

'PropertyValid' 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 'PropertyValid' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

US Patent Requested