actions - Test mode - WEBSALE Dokumentation

This area covers all actions used to control the test mode. They allow you to activate, deactivate or toggle the test mode within the system.

`actions.testMode*` - Test mode

The actions listed here are grouped thematically to present the associated error messages and email templates in a clear structure. Actions that belong to another topic area can be found in the corresponding sections of this documentation or in the alphabetical overview of the actions.

Excerpt of the basic `actions` structure

{
    "actions": {
      ...
      "testModeChange": {...},
      "testModeOff": {...},
      "testModeOn": {...},
      ...
    }
}

Action overview

Action	Description
`testModeOn`	Defines the error messages output on requests to activate the test mode.
`testModeOff`	Defines the error message output on requests to deactivate the test mode.
`testModeChange`	Defines the error messages output on requests to change the test mode.

`actions.testModeChange` - Change test mode

The testModeChange action controls the error messages for requests to change the test mode.

Example configuration

{
  "errorCodes": {
    "notAllowed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`notAllowed`	string	Error message output when changing the test mode is not allowed in the current context.

`actions.testModeOff` - Deactivate / switch off test mode

The testModeOff action controls the error messages for requests to deactivate the test mode.

Example configuration

{
  "errorCodes": {
    "notAllowed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`notAllowed`	string	Error message output when deactivating the test mode is not allowed in the current context.

`actions.testModeOn` - Activate / switch on test mode

The testModeOn action controls the error messages for requests to activate the test mode.

Example configuration `actions.testModeOn`

{
  "errorCodes": {
    "noPassword": "<Textbaustein>",
    "invalidPassword": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`noPassword`	string	Error message output when no password was supplied.
`invalidPassword`	string	Error message output when the supplied password is invalid.

​actions.testMode* - Test mode

​Excerpt of the basic actions structure

​Action overview

​actions.testModeChange - Change test mode

​Example configuration

​Parameter overview

​actions.testModeOff - Deactivate / switch off test mode

​Example configuration

​Parameter overview

​actions.testModeOn - Activate / switch on test mode

​Example configuration actions.testModeOn

​Parameter overview

`actions.testMode*` - Test mode

Excerpt of the basic `actions` structure

Action overview

`actions.testModeChange` - Change test mode

Example configuration

Parameter overview

`actions.testModeOff` - Deactivate / switch off test mode

Example configuration

Parameter overview

`actions.testModeOn` - Activate / switch on test mode

Example configuration `actions.testModeOn`

Parameter overview