Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′PropertyGroupValid′ Reference Documentation
Description
The following table displays the documentation for the 'PropertyGroupValid' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Verifies if a property group has been defined for a specific solution on VersaCloud |
Español (moderno) |
Verifica si un grupo de propiedades ha sido definido para una solución específica en VersaCloud |
Português (Brasil) |
Verifica se um grupo de propriedades foi definido para uma solução específica em VersaCloud |
Parameters
The following table describes all of 'PropertyGroupValid''s parameters, in every language available.
ID: 1 - Name: SolutionName
Language: English (United States)
Description: String containing the solution's name (as defined when calling SolutionAddAllow)
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 name of the property category the group 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 to be verified if valid as the name of a property group
Type: string - Min-Max Length: 4-64 - Reentr Key Member: No - Optional: No
ID: 1 - Name: SolutionName
Language: Español (moderno)
Description: Secuencia de caracteres conteniendo el nombre de la solución (conforme definido al llamar SolutionAddAllow)
Type: solution - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 2 - Name: PropertyCategoryName
Language: Español (moderno)
Description: Secuencia de caracteres conteniendo el nombre de la categoría de propriedades a la cual pertenece el grupo a ser validado
Type: propertycategory - Min-Max Length: 4-48 - Reentr Key Member: No - Optional: No
ID: 3 - Name: PropertyGroupName
Language: Español (moderno)
Description: Secuencia de caracteres a ser validada como siendo un nombre válido de un grupo de propriedades
Type: string - Min-Max Length: 4-64 - Reentr Key Member: No - Optional: No
ID: 1 - Name: SolutionName
Language: Português (Brasil)
Description: Sequencia de caracteres contendo o nome da solução (conforme definido ao chamar SolutionAddAllow)
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 à qual o grupo a ser verificado pertence
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 a ser verificada como sendo um nome válido de grupo de propriedades
Type: string - Min-Max Length: 4-64 - Reentr Key Member: No - Optional: No
---
Return Value
'PropertyGroupValid' 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 'PropertyGroupValid' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|
US Patent Requested
