VersaCloud API ′PropertyValueGet′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Retrieves the value of a specific property for a specific user
Español (moderno)	Recupera el valor de una propiedad específica para un usuario específico
Português (Brasil)	Recupera o valor de uma propriedade específica para um usuário específico

Parameters

The following table describes all of 'PropertyValueGet''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 value

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: 6 - Name: LanguageCode

Language: English (United States)

Description: Language the property's value will be retrieved

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No

 

ID: 7 - Name: When

Language: English (United States)

Description: (Optional) Specific date to be used to retrieve porperty's value; if unspecified, value at curent date/time will be retrieved

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: Yes

 

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 valor 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: 6 - Name: LanguageCode

Language: Español (moderno)

Description: Idioma en el cual se desea obtener el valor de la propriedad

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No

 

ID: 7 - Name: When

Language: Español (moderno)

Description: (Opcional) Fecha específica para la cual desea obtener el valor de la propriedad; si no especificada, obtendrá el valor vigente al momento de la llamada

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: Yes

 

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 valor 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

 

ID: 6 - Name: LanguageCode

Language: Português (Brasil)

Description: Idioma no qual se deseja obter o valor da propriedade

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No

 

ID: 7 - Name: When

Language: Português (Brasil)

Description: (Opcional) Data específica para a qual deseja obter o valor da propriedade; se não especifica, é obtido o valor vigente no momento da chamada

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: Yes

---

Return Value

'PropertyValueGet' returns a value of type string (minimum length of returned values is one character characters, while maximum length of returned values is 256 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 'PropertyValueGet' 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#Prp0000019	English (United States)	Value of this property hasn't been set for the specified human language
:@Err#Prp0000016	Español (moderno)	Valor informado como nombre de propriedad no ha sido definido en la solución especificada
:@Err#Prp0000019	Español (moderno)	Valor de esta propriedad no ha sido definido en el idioma humano indicado
:@Err#Prp0000016	Português (Brasil)	Valor fornecido como nome de propriedade não foi definido na solução especificada
:@Err#Prp0000019	Português (Brasil)	Valor desta propriedade não foi definido no idioma humano especificado

US Patent Requested