> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mastermindcms.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SettingsManagementServiceImpl

> Calling public service methods through the REST API: settingsManagementServiceImpl

<ResponseField name="beanId" type="string">
  The Spring bean identifier containing the service being called.

  settingsManagementServiceImpl
</ResponseField>

<ResponseField name="scope" type="string" default="PROTOTYPE">
  Bean scope. Use PROTOTYPE for service calls.
</ResponseField>

<ResponseField name="functionName" type="string">
  The public service method name shown in the signature below.
</ResponseField>

<ResponseField name="args" type="object[]">
  The method argument array. Each argument is passed as an object with index 0, 1, and so on; the value must match the Java parameter type.
</ResponseField>

## Headers

```http theme={null}
POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: en
Site-Context: my-site
Authorization: Bearer <token>
```

Send `Lang-Context` and `Site-Context` with every request. For protected methods, send the JWT in the `Authorization` header as `Bearer <token>`.

**Access:** ADMIN. **Bearer Token:** required.

* GUEST — unauthenticated users; only whitelist services are available.
* USER — authentication is required; methods with USER checks are available.
* ADMIN — full access to public methods of all services.
* If a method checks a role internally, GUEST may receive null.

## Methods

<ResponseField name="getRepository" type="WebSiteSettingsRepository">
  | Argument | Type | Description                            |
  | -------- | ---- | -------------------------------------- |
  | —        | —    | This method does not accept arguments. |

  ### getRepository

  ```json theme={null}
  {
    "beanId": "settingsManagementServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getRepository",
    "args": []
  }
  ```
</ResponseField>

<ResponseField name="searchSettingsResultsPaged" type="Page<WebSiteSettings>">
  | Argument      | Type     | Description                 |
  | ------------- | -------- | --------------------------- |
  | `requestJson` | `String` | Passed through `args[0].0`. |

  ### searchSettingsResultsPaged

  ```json theme={null}
  {
    "beanId": "settingsManagementServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "searchSettingsResultsPaged",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="searchSettingsResults" type="List<WebSiteSettings>">
  | Argument      | Type     | Description                 |
  | ------------- | -------- | --------------------------- |
  | `requestJson` | `String` | Passed through `args[0].0`. |

  ### searchSettingsResults

  ```json theme={null}
  {
    "beanId": "settingsManagementServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "searchSettingsResults",
    "args": [
      {
        "0": "{\"query\":{}}"
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="createSettings" type="WebSiteSettings">
  | Argument        | Type                            | Description                 |
  | --------------- | ------------------------------- | --------------------------- |
  | `settingsAsMap` | `LinkedHashMap<String, Object>` | Passed through `args[0].0`. |

  ### createSettings

  Example JSON request object:

  ```json theme={null}
  {
      "id":  null,
      "loginPage":  null,
      "resetPasswordPage":  null,
      "userAccountRoot":  null,
      "userAccountPage":  null,
      "ordersPage":  null,
      "orderCheckoutPage":  null,
      "checkoutReturnPage":  null,
      "page403":  null,
      "page404":  null,
      "verifyEmailTemplate":  null,
      "welcomeEmailTemplate":  null,
      "resetPasswordEmailTemplate":  null,
      "messageNotifyEmailTemplate":  null,
      "contactSupplierEmailTemplate":  null,
      "tariffBookingEmailTemplate":  null,
      "uploadRequestEmailTemplate":  null,
      "orderConfirmationEmailTemplate":  null
  }
  ```

  Request:

  ```json theme={null}
  {
    "beanId": "settingsManagementServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "createSettings",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="saveSettings" type="WebSiteSettings">
  | Argument        | Type                            | Description                 |
  | --------------- | ------------------------------- | --------------------------- |
  | `settingsAsMap` | `LinkedHashMap<String, Object>` | Passed through `args[0].0`. |

  ### saveSettings

  Example JSON request object:

  ```json theme={null}
  {
      "id":  null,
      "loginPage":  null,
      "resetPasswordPage":  null,
      "userAccountRoot":  null,
      "userAccountPage":  null,
      "ordersPage":  null,
      "orderCheckoutPage":  null,
      "checkoutReturnPage":  null,
      "page403":  null,
      "page404":  null,
      "verifyEmailTemplate":  null,
      "welcomeEmailTemplate":  null,
      "resetPasswordEmailTemplate":  null,
      "messageNotifyEmailTemplate":  null,
      "contactSupplierEmailTemplate":  null,
      "tariffBookingEmailTemplate":  null,
      "uploadRequestEmailTemplate":  null,
      "orderConfirmationEmailTemplate":  null
  }
  ```

  Request:

  ```json theme={null}
  {
    "beanId": "settingsManagementServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "saveSettings",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="removeSettingsByIds" type="void">
  | Argument      | Type                | Description                 |
  | ------------- | ------------------- | --------------------------- |
  | `settingsIds` | `ArrayList<String>` | Passed through `args[0].0`. |

  ### removeSettingsByIds

  ```json theme={null}
  {
    "beanId": "settingsManagementServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "removeSettingsByIds",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="removeSettingsAndClean" type="void">
  | Argument     | Type     | Description                 |
  | ------------ | -------- | --------------------------- |
  | `settingsId` | `String` | Passed through `args[0].0`. |

  ### removeSettingsAndClean

  ```json theme={null}
  {
    "beanId": "settingsManagementServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "removeSettingsAndClean",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="getSettingsPaginationFilter" type="Deque<Map<String, Object>>">
  | Argument      | Type     | Description                 |
  | ------------- | -------- | --------------------------- |
  | `requestJson` | `String` | Passed through `args[0].0`. |

  ### getSettingsPaginationFilter

  ```json theme={null}
  {
    "beanId": "settingsManagementServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "getSettingsPaginationFilter",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>