Description

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

Language

Documentation

English (United States)

Requests the creation of a new property category

Español (moderno)

Pide la creación de una nueva categoría de propiedades

Português (Brasil)

Solicita a criação de uma nova categoria de propriedades

Parameters

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

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

SolutionToken

English (United States)

Token identifying solution the new property category will belong to (only 'master' tokens are accepted)

solutiontoken

128-128

No

No

2

PropertyCategoryName

English (United States)

String to be used as the name of the new property category

string

1-48

Yes

No

1

SolutionToken

Español (moderno)

Token de solución identificando la solución a la cual pertenecerá la nueva categoría de propriedades (sólamente tokens 'master' son aceptados)

solutiontoken

128-128

No

No

2

PropertyCategoryName

Español (moderno)

Secuencia de carácteres a ser usada como nombre de la nueva categoría de propriedades

string

1-48

Yes

No

1

SolutionToken

Português (Brasil)

Token de solução identificando a solução à qual a nova categoria de propriedades pertencerá (somente tokens 'master' são aceitos)

solutiontoken

128-128

No

No

2

PropertyCategoryName

Português (Brasil)

Sequencia de caracteres a ser usada como nome da nova categoria de propriedades

string

1-48

Yes

No

Return Value

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

Errorcode

Language

Description

:@Err#Prp0000011

English (United States)

Value provided as new property category already exists for specified solution

:@Err#Sol0000006

English (United States)

Solution Token is not valid

:@Err#Prp0000011

Español (moderno)

Valor informado como nueva categoría de propriedades ya existe en la solución especificada

:@Err#Sol0000006

Español (moderno)

Token de solución no es válido

:@Err#Prp0000011

Português (Brasil)

Valor fornecido como nova categoria de propriedades já existe na solução especificada

:@Err#Sol0000006

Português (Brasil)

Token de solução não é válido

US Patent Requested