| home > API > [/user/get_properties] > |
| request url |
https://[SERVER]:[PORT]/user/get_properties[?PARAMETER1=value[&...]] |
| short description |
Shows values of user properties |
| long description |
|
| parameters |
| name |
type |
description |
| elements |
identifier |
Comma separated list of user property element identifiers. |
| name_elements |
string |
Comma separated list of names of user property elements. Used only if elements parameter is omitted. |
| sid |
string |
Session identifier for a server connection. Use the /server/login request to get a valid session identifier. |
|
| result |
| # |
name |
type |
description |
| 0 |
type |
integer |
Type of the value (1=NUMERIC, 2=STRING, 99=ERROR) |
| 1 |
exists/error |
integer |
1 if value exists. In case of an error the error code. |
| 2 |
value |
double/string |
Value of the property. In case of an error the error message |
|
| examples |
|
| further information |
|