conversions.get
Get conversions attributes.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
Response
| struct |
{ |
|
| string |
statusMessage |
Status code description
|
| string |
session |
Refreshed session
|
| array |
conversions ( |
|
| struct |
{ |
|
| string |
name |
Conversion name
|
| int |
conversionTypeId |
Conversion type id (see listConversionTypes() for conversion type enumeration)
|
| string |
conversionTypeName |
Conversion type name (see listConversionTypes() for conversion type enumeration)
|
| string |
proto |
Protocol (DEPRECATED, always returns empty string)
|
| string |
color |
(can be null) Conversion color in hexadecimal format (white=ffffff) or nil
|
| int |
value |
(can be null) Conversion value (in halers) or nil
|
| bool |
removed |
Whether conversion is removed
|
| int |
userId |
Conversion owner user id
|
|
} |
|
|
|
) |
|
|
| array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
conversion_access_denieduser_access_denied
