GET api/AppSettings/{affiliateId}/{appSettingGroup}
Returns RESULTANT the App Settings for a given affiliate and AppSettingsGroup
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
affiliateId |
The Id of the affiliate whose settings to return |
integer |
Required |
appSettingGroup |
The AppSetting Group (type of client). e.g. 'Clients-Android' |
string |
Required |
v |
The requested API version |
string |
Required Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
Returns RESULTANT the App Settings for a given affiliate and AppSettingsGroup
Collection of FilmFlex.Platform.Common.API.Contracts.V1.AppSettingDTOName | Description | Type | Additional information |
---|---|---|---|
SettingKey |
The setting key |
string |
None. |
AffiliateId |
Affiliate Id. Zero indicates that this setting applies to all affiliates unless overridden |
integer |
None. |
SettingValue |
The setting value. |
string |
None. |
SettingGroup |
The group that this setting applies to. Each client is will be interested in the settings contained in a group and it's parent groups |
string |
None. |
IsHtml |
Indicates if this setting is in HTML |
boolean |
None. |
IsJson |
Indicates if this setting is in JSON |
boolean |
None. |
IsLocked |
Indicates that this setting can not be edited in the DCR Admin UI |
boolean |
None. |
IsHidden |
Indicates that this setting should be hidden from all default AppSetting requests. This can be overridden for internal requests. |
boolean |
None. |
Description |
Description of the App Setting |
string |
None. |
ModifiedDate |
Last modified date and time |
date |
None. |
ModifiedBy |
Modified by |
string |
None. |
Response Formats
application/json, text/json
[ { "SettingKey": "sample string 1", "AffiliateId": 2, "SettingValue": "sample string 3", "SettingGroup": "sample string 4", "IsHtml": true, "IsJson": true, "IsLocked": true, "IsHidden": true, "Description": "sample string 9", "ModifiedDate": "2025-09-04T07:13:28.6811869+00:00", "ModifiedBy": "sample string 11" }, { "SettingKey": "sample string 1", "AffiliateId": 2, "SettingValue": "sample string 3", "SettingGroup": "sample string 4", "IsHtml": true, "IsJson": true, "IsLocked": true, "IsHidden": true, "Description": "sample string 9", "ModifiedDate": "2025-09-04T07:13:28.6811869+00:00", "ModifiedBy": "sample string 11" } ]