POST api/Customers/MarketingFlags

Returns all the marketing flags that are presented to customers so that they can opt-in to varying options.

Request Information

URI Parameters

None.

Body Parameters

EskimoClassLibraries.clsMarketingFlagArguments

Name	Description	Type	Additional information
Active		EskimoClassLibraries.modEnums+FilterEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "Active": 0
}

application/xml, text/xml

Sample:

<clsMarketingFlagArguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <Active>Exclude</Active>
</clsMarketingFlagArguments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsMarketingFlag

Name	Description	Type	Additional information
ID	ID and DB Primary Key of the Flag	integer	Required
Description	Name of the marketing flag to display to the operator in the UI.	string	Required String length: inclusive between 0 and 150
ExtDescription	Extended Description that gives a more detailed explaination about what this options means in practice.	string	Required String length: inclusive between 0 and 3000
Children	An array of sub-options for this flag.	Collection of EskimoClassLibraries.clsMarketingFlag	None.
FlagType	Controls how the flag should be displayed in the UI	EskimoClassLibraries.clsMarketingFlag+FlagTypeEnum	None.
Active	Determines if the flag is active and should be displayed in the UI	boolean	None.
DefaultValue	The default state of the flag	boolean	None.
OrderBy	Determines the order in which to display the items in the UI	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Description": "sample string 2",
    "ExtDescription": "sample string 3",
    "Children": [],
    "FlagType": 0,
    "Active": true,
    "DefaultValue": true,
    "OrderBy": 6
  },
  {
    "ID": 1,
    "Description": "sample string 2",
    "ExtDescription": "sample string 3",
    "Children": [],
    "FlagType": 0,
    "Active": true,
    "DefaultValue": true,
    "OrderBy": 6
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.