conversions.check
Check conversions attributes before updating or creating a new one.
Parameters
struct |
user { |
|
string |
session |
Session (as retrieved from client.loginByToken() )
|
int |
userId |
(optional) Managed user ID
|
|
} |
|
|
array |
conversions ( |
|
struct |
{ |
|
int |
id |
(optional) Conversion ID, set if you are going to check updating
|
int |
conversionTypeId |
(optional) Conversion type ID, set if you are going to check creating
|
string |
name |
(optional) Conversion name
|
string |
proto |
(optional) (can be null) protokol (DEPRECATED, this argument is ignored)
|
string |
color |
(optional) Conversion color in hexadecimal format (white=ffffff)
|
int |
value |
(optional) Conversion value (in halers)
|
|
} |
|
|
|
) |
|
|
Response
struct |
{ |
|
string |
statusMessage |
Status code description
|
string |
session |
Refreshed session
|
array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK
206: Partially OK
301: User is serviced
400: Bad arguments
401: Invalid session
403: Access Denied
404: Not found
406: Bad values of attributes
413: Too many items requested.
429: Too many requests. Has to wait.
500: Server Error.
409: Conflict
Diagnostics:
List of all possible diagnostics:
ambiguous_check: Some items contain conversionId and any not! Can not recognize check category (create or update?)
conversion_access_denied
conversion_missing_attribute
conversion_wrong_color
conversion_wrong_conversion_type_id
conversions.create
user_access_denied