Application Setting Resource

Get All Culture Settings

HTTP Request

GET /api/applicationSetting/culture

Interactive Demo

📋 Description: Retrieves the current culture settings for the application, enabling users to understand and adapt the user interface according to regional preferences.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "displayId": "string",
    "name": "string",
    "code": "string",
    "isDefault": true,
    "objectAvailable": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[CultureDTO]	false	none	[Data transfer object representing cultural attributes and values within an organization, facilitating the alignment of workforce initiatives with corporate identity and employee engagement strategies.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» displayId	string	false	none	Unique identifier for the display
» name	string	false	none	Name of the resource
» code	string	false	none	Code identifier for the resource
» isDefault	boolean	false	none	Whether the resource is default
» objectAvailable	boolean	false	none	Indicates whether the cultural object is currently available for use within the system.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update Culture Setting

HTTP Request

POST /api/applicationSetting/culture

Interactive Demo

📋 Description: Sets the culture settings for the application, allowing businesses to customize user experience and align with organizational values.

Parameters

Name	In	Type	Required	Description
body	body	CultureDTO	true	Request body containing the cultural settings data to configure application localization preferences.

Body Parameters

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "displayId": "string",
    "name": "string",
    "code": "string",
    "isDefault": true,
    "objectAvailable": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get All Settings

HTTP Request

GET /api/applicationSetting/

Interactive Demo

📋 Description: Fetches the current application settings, providing essential configuration details to ensure optimal system performance and user experience.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "settingGroup": "GENERAL_SETTING",
    "captionKey": "string",
    "settingValue": "string",
    "inApp": true,
    "email": true,
    "settingComponentType": "TOGGLE"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ApplicationSettingDTO]	false	none	[Data transfer object representing application settings, including configuration parameters and preferences that govern the behavior of the application within an enterprise environment.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» settingGroup	string	false	none	Identifier for the group of application settings, facilitating organized management and retrieval of related configuration parameters.
» captionKey	string	false	none	Key used to retrieve the corresponding caption for application settings, facilitating consistent user interface messaging across the platform.
» settingValue	string	false	none	The settingValue field represents the specific configuration value associated with an application setting, enabling customization and optimization of application behavior.
» inApp	boolean	false	none	Indicates whether in-app features are enabled for the application, allowing for enhanced user engagement and functionality.
» email	boolean	false	none	Indicates whether email notifications are enabled for application settings within the system.
» settingComponentType	string	false	none	Type of the setting component

Enumerated Values

Attribute	Value
settingComponentType	DATE, DROPDOWN, NUMBER, TEXT, TEXTAREA, TOGGLE
settingGroup	GENERAL_SETTING, NOTIFICATION_SETTING

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update Application Setting

HTTP Request

POST /api/applicationSetting/

Interactive Demo

📋 Description: Creates a new application setting within the system, enabling the customization of application behavior to meet specific business requirements.

Parameters

Name	In	Type	Required	Description
body	body	ApplicationSettingDTO	true	Request body containing the application settings configuration data, including key-value pairs that define user preferences and system behavior.

Body Parameters

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "settingGroup": "GENERAL_SETTING",
    "captionKey": "string",
    "settingValue": "string",
    "inApp": true,
    "email": true,
    "settingComponentType": "TOGGLE"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Application Setting By ID

HTTP Request

GET /api/applicationSetting/{id}

Interactive Demo

📋 Description: Fetches the application settings associated with the specified ID, enabling users to access and review configuration details essential for application management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ApplicationSettingDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "settingGroup": "GENERAL_SETTING",
  "captionKey": "string",
  "settingValue": "string",
  "inApp": true,
  "email": true,
  "settingComponentType": "TOGGLE"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Application Setting

HTTP Request

GET /api/applicationSetting/{captionKey}

Interactive Demo

📋 Description: Fetches the application setting associated with the specified caption key, enabling users to access configuration details relevant to their operational needs.

Parameters

Name	In	Type	Required	Description
captionKey	path	string	true	Identifier for the specific application setting caption to retrieve its associated value from the system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ApplicationSettingDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "settingGroup": "GENERAL_SETTING",
  "captionKey": "string",
  "settingValue": "string",
  "inApp": true,
  "email": true,
  "settingComponentType": "TOGGLE"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get All Notification Settings

HTTP Request

GET /api/applicationSetting/notification

Interactive Demo

📋 Description: Retrieves the current notification settings for the application, enabling users to review and manage their notification preferences effectively.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "settingGroup": "GENERAL_SETTING",
    "captionKey": "string",
    "settingValue": "string",
    "inApp": true,
    "email": true,
    "settingComponentType": "TOGGLE"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ApplicationSettingDTO]	false	none	[Data transfer object representing application settings, including configuration parameters and preferences that govern the behavior of the application within an enterprise environment.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» settingGroup	string	false	none	Identifier for the group of application settings, facilitating organized management and retrieval of related configuration parameters.
» captionKey	string	false	none	Key used to retrieve the corresponding caption for application settings, facilitating consistent user interface messaging across the platform.
» settingValue	string	false	none	The settingValue field represents the specific configuration value associated with an application setting, enabling customization and optimization of application behavior.
» inApp	boolean	false	none	Indicates whether in-app features are enabled for the application, allowing for enhanced user engagement and functionality.
» email	boolean	false	none	Indicates whether email notifications are enabled for application settings within the system.
» settingComponentType	string	false	none	Type of the setting component

Enumerated Values

Attribute	Value
settingComponentType	DATE, DROPDOWN, NUMBER, TEXT, TEXTAREA, TOGGLE
settingGroup	GENERAL_SETTING, NOTIFICATION_SETTING

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get All General Settings

HTTP Request

GET /api/applicationSetting/general

Interactive Demo

📋 Description: Retrieves general application settings, providing essential configuration details that support the overall functionality and user experience of the application.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "settingGroup": "GENERAL_SETTING",
    "captionKey": "string",
    "settingValue": "string",
    "inApp": true,
    "email": true,
    "settingComponentType": "TOGGLE"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ApplicationSettingDTO]	false	none	[Data transfer object representing application settings, including configuration parameters and preferences that govern the behavior of the application within an enterprise environment.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» settingGroup	string	false	none	Identifier for the group of application settings, facilitating organized management and retrieval of related configuration parameters.
» captionKey	string	false	none	Key used to retrieve the corresponding caption for application settings, facilitating consistent user interface messaging across the platform.
» settingValue	string	false	none	The settingValue field represents the specific configuration value associated with an application setting, enabling customization and optimization of application behavior.
» inApp	boolean	false	none	Indicates whether in-app features are enabled for the application, allowing for enhanced user engagement and functionality.
» email	boolean	false	none	Indicates whether email notifications are enabled for application settings within the system.
» settingComponentType	string	false	none	Type of the setting component

Enumerated Values

Attribute	Value
settingComponentType	DATE, DROPDOWN, NUMBER, TEXT, TEXTAREA, TOGGLE
settingGroup	GENERAL_SETTING, NOTIFICATION_SETTING

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---