Error

This is the general error model that can be returned by any API call.

Predefined error codes

code	description
async_action_end_error	The specified async action ended with error.
async_action_end_minor	The specified async action ended with minor errors.
async_action_lost	The specified async action was lost.
firmware_upgrade_error	Firmware upload or upgrade error.
remote_call_error	Remote access error.
rpc_server_error	General server error.
rpc_compatibility_error	Error caused by incompatibility.
rpc_invalid_request	The request payload can not be parsed or does not match the expected structure.
rpc_invalid_parameter	The method call parameters are invalid.
rpc_temporarily_unavailable	Server can not respond at this time, but it is expected to be able to reply in the future.
rpc_method_not_found	The specified method does not exist.
rpc_permission_denied	User does not have sufficient permissions to complete this request.
rpc_async_action_in_progress	The specified async action is still in progress, result will be available later.
rpc_fatal_error	An error the client is not expected to handle (e.g. HW error).
self_passwd_invalid	The old password is wrong or the new password is invalid.
settings_save_error	Error while applying the new configuration.
user_change_pass_invalid	Cannot change password of the user.
user_create_invalid	The definition of the new user is invalid.
user_delete_invalid	Cannot delete user.
user_update_invalid	Cannot update attributes of the user.
users_restore_invalid	Backup file is invalid, cannot restore user accounts.
validation_error	Configuration failed consistency check.

Model

attribute	description
code* string	Used to determine how the application should behave after the error.
message_id* i18n@errors	The translation message identifier.
message_params { string: string }	An object holding values to be interpolated into the translated string.
log string	Log to be displayed to the user as is (no translation, additional formatting etc.).
suberrors [Suberror]	An array holding other errors that caused the main error.

Suberror

attribute	description
message_id* i18n@errors	The translation message identifier.
message_params { string: string }	An object holding values to be interpolated into the translated string.
seids [seid]	An array of seids related to this suberror.