ResetSettings

Deletes all custom settings stored for the specified login. The operation acts on rows in the settings storage; it does not delete or modify the trading account.

The same handler is exposed through the HTTP alias DELETE /settings, while this page documents the TCP command.

Access

The authenticated session must have all applicable access requirements:

• session type: SESSION_MANAGER, SESSION_ADMIN, or SESSION_DEALER;
• scope: access_backoffice;
• permission: set_accounts.

SESSION_USER and SESSION_CUSTOMER cannot call this method. The target login is taken from request data.login; it is not substituted from the manager session.

Request Parameters

Name	Type	Required	Description
login	int	Yes	Non-zero trading-account login whose complete custom-settings set must be deleted.

Authentication metadata such as __token belongs to the TCP envelope and is not part of data. The internal __access object is created by the server and must not be supplied by the client.

Full Request Example

{
  "command": "ResetSettings",
  "extID": "reset-settings-123456",
  "__token": "manager-jwt",
  "data": {
    "login": 123456
  }
}

Response Parameters

The handler response is returned inside the TCP response envelope's data object.

Name	Type	Description
data	string	Literal "OK" when the reset completed, including when no settings existed.

Full Successful Response

{
  "extID": "reset-settings-123456",
  "status": 200,
  "data": {
    "data": "OK"
  }
}

Success means that the delete statement completed. The operation is idempotent: if the login has no stored custom settings, it still returns the same successful response. The method does not return the number or keys of deleted settings.

Errors

Status	Error	Description
400	INVALID_DATA	login is absent or is not an integer.
401	Authentication error	The TCP token is absent, invalid, or expired.
403	Access denied	Session type, access_backoffice scope, or set_accounts permission is missing.
403	INVALID_ACCESS	The resolved target login is zero.
500	INVALID_RESET_SETTINGS	Settings storage is unavailable or the delete operation failed.

Example handler failure payload:

{
  "extID": "reset-settings-123456",
  "status": 500,
  "data": {
    "error": "INVALID_RESET_SETTINGS",
    "message": "Unknown error"
  }
}

The message is produced from the underlying storage error and may differ by failure. The absence of stored settings is not an error.

The command uses JOURNAL_POLICY_ALL, so both successful and failed attempts are recorded in the operational journal.