Description

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

Language

Documentation

English (United States)

Retrieves the type of a specific property

Español (moderno)

Recupera el tipo de una propiedad específica

Português (Brasil)

Recupera o tipo de uma propriedade específica

Parameters

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

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

Login

English (United States)

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

operationhandle

48-48

No

No

2

SolutionName

English (United States)

String containing the name of the solution the property belongs to

solution

8-32

No

No

3

PropertyCategoryName

English (United States)

String containing the name of the category the property belongs to

propertycategory

4-48

No

No

4

PropertyGroupName

English (United States)

String containing the name of the group the property belongs to

propertygroup

4-64

No

No

5

PropertyName

English (United States)

String containing the name of the property

property

4-80

No

No

1

Login

Español (moderno)

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

operationhandle

48-48

No

No

2

SolutionName

Español (moderno)

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

solution

8-32

No

No

3

PropertyCategoryName

Español (moderno)

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

propertycategory

4-48

No

No

4

PropertyGroupName

Español (moderno)

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

propertygroup

4-64

No

No

5

PropertyName

Español (moderno)

Secuencia de caracteres conteniendo el nombre de la propiedad

property

4-80

No

No

1

Login

Português (Brasil)

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

operationhandle

48-48

No

No

2

SolutionName

Português (Brasil)

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

solution

8-32

No

No

3

PropertyCategoryName

Português (Brasil)

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

propertycategory

4-48

No

No

4

PropertyGroupName

Português (Brasil)

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

propertygroup

4-64

No

No

5

PropertyName

Português (Brasil)

Sequencia de caracteres contendo o nome da propriedade

property

4-80

No

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):

Errorcode

Language

Description

:@Err#Prp0000016

English (United States)

Value provided as property name hasn't been defined inside specified solution

:@Err#Prp0000016

Español (moderno)

Valor informado como nombre de propriedad no ha sido definido en la solución especificada

:@Err#Prp0000016

Português (Brasil)

Valor fornecido como nome de propriedade não foi definido na solução especificada

US Patent Requested