VersaCloud API ′PropertyTypeGet′ Reference Documentation

Description

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

Parameters

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

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow, identifying user requesting the property's type

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

ID: 2 - 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: 3 - Name: PropertyCategoryName

Language: English (United States)

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

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

ID: 4 - Name: PropertyGroupName

Language: English (United States)

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

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

ID: 5 - Name: PropertyName

Language: English (United States)

Description: String containing the name of the property

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

ID: 1 - Name: Login

Language: Español (moderno)

Description: Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando el usuario que busca el tipo de una propriedad

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

ID: 2 - Name: SolutionName

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo el nombre de la solución a la cual pertenece la propiedad

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

ID: 3 - Name: PropertyCategoryName

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo el nombre de la categoría a la cual pertenece la propiedad

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

ID: 4 - Name: PropertyGroupName

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo el nombre del grupo al cual pertenece la propiedad

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

ID: 5 - Name: PropertyName

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo el nombre de la propiedad

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

ID: 1 - Name: Login

Language: Português (Brasil)

Description: Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o usuário que procura o tipo de uma propriedade

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

ID: 2 - 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: 3 - Name: PropertyCategoryName

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o nome da categoria à qual a propriedade pertence

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

ID: 4 - Name: PropertyGroupName

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o nome do grupo à qual a propriedade pertence

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

ID: 5 - Name: PropertyName

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o nome da propriedade

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

---

Return Value

'PropertyTypeGet' returns a value of type type (minimum length of returned values is 3 characters characters, while maximum length of returned values is 24 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 'PropertyTypeGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

US Patent Requested