VersaCloud API ′PropertyValuePerUserSetAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests storage of a property value for a specific VersaCloud user
Español (moderno)	Pide almacenamiento de un valor de la propiedad para un usuario específico VersaCloud
Português (Brasil)	Solicitações de armazenamento de um valor de propriedade de um usuário específico VersaCloud

Parameters

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

 

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow

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 solution's name to have a new property type added

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

 

ID: 3 - Name: PropertyCategoryName

Language: English (United States)

Description: String containing the name of the property category the new value will be part of

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

 

ID: 4 - Name: PropertyGroupName

Language: English (United States)

Description: String containing the name of the property group the new value will be part of

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

 

ID: 5 - Name: PropertyName

Language: English (United States)

Description: String containing the name of the property the new value will be assigned to

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

 

ID: 6 - Name: LanguageCode

Language: English (United States)

Description: Language the new property value corresponds to

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

 

ID: 7 - Name: Value

Language: English (United States)

Description: New value to be assigned to the property specified by previous arguments

Type: string - Min-Max Length: 1-256 - Reentr Key Member: No - Optional: No

 

ID: 8 - Name: Since

Language: English (United States)

Description: Initial date from which the property will use this value (optional; if empty, current date/time will be used)

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

 

ID: 9 - Name: Until

Language: English (United States)

Description: Final date until which the property will use this value (optional; if empty, '2399-12-31 23:59:59.987' will be used)

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

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 identificando la solución a la cual pertencerá el nuevo valor de propriedad (cualquier token, master o clon, puede ser utilizado)

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

 

ID: 3 - Name: PropertyCategoryName

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo el nombre de la categoría de propriedades de la cual el nuevo valor formará parte

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

 

ID: 4 - Name: PropertyGroupName

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo el nombre del grupo de propriedades de la cual el nuevo valor formará parte

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

 

ID: 5 - Name: PropertyName

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo el nombre de la propriedad a la cual el nuevo valor será atribuido

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

 

ID: 6 - Name: LanguageCode

Language: Español (moderno)

Description: Idioma al cual corresponde el nuevo valor de propriedad

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

 

ID: 7 - Name: Value

Language: Español (moderno)

Description: Nuevo valor a ser asignado a la propriedad especificada por los parámetros anteriores

Type: string - Min-Max Length: 1-256 - Reentr Key Member: No - Optional: No

 

ID: 8 - Name: Since

Language: Español (moderno)

Description: Fecha a partir de la cual la propriedad usará el valor especificado (opcional; si omitida, la fecha/hora actual será utilizada)

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

 

ID: 9 - Name: Until

Language: Español (moderno)

Description: Fecha hasta la cual la propriedad usará el valor especificado (opcional; si omitida, '2399-12-31 23:59:59.987' será utilizada)

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

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 identificando a solução à qual o novo valor de propriedade pertencerá (qualquer token, master ou clone, pode ser usado)

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

 

ID: 3 - Name: PropertyCategoryName

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o nome da categoria de propriedades da qual o novo valor será parte

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

 

ID: 4 - Name: PropertyGroupName

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o nome do grupo de propriedades da qual o novo valor será parte

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

 

ID: 5 - Name: PropertyName

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o nome da propriedade à qual o novo valor será atribuido

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

 

ID: 6 - Name: LanguageCode

Language: Português (Brasil)

Description: Idioma ao qual o novo valor de propriedade corresponde

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

 

ID: 7 - Name: Value

Language: Português (Brasil)

Description: Novo valor a ser atribuido à propriedade especificada pelos parâmetros anteriores

Type: string - Min-Max Length: 1-256 - Reentr Key Member: No - Optional: No

 

ID: 8 - Name: Since

Language: Português (Brasil)

Description: Data a partir da qual a propriedade usará o valor especificado (opcional; se omitida, a data/hora atual será assumida)

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

 

ID: 9 - Name: Until

Language: Português (Brasil)

Description: Data até a qual a propriedade usará o valor especificado (opcional; se omitida, '2399-12-31 23:59:59.987' será assumida)

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

---

Return Value

'PropertyValuePerUserSetAllow' 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 'PropertyValuePerUserSetAllow' 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#Tim0000009	English (United States)	Time interval specified is not correct
:@Err#Prp0000016	Español (moderno)	Valor informado como nombre de propriedad no ha sido definido en la solución especificada
:@Err#Tim0000009	Español (moderno)	El intervalo de tiempo especificado no es correcto
:@Err#Prp0000016	Português (Brasil)	Valor fornecido como nome de propriedade não foi definido na solução especificada
:@Err#Tim0000009	Português (Brasil)	O intervalo de tempo especificado não é correto

US Patent Requested