BokaMera.API.Host

CreateIncentiveAction

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
POST	/superadmin/incentives/action	Add a new incentive action

**CreateIncentiveAction** Parameters:
Name	Parameter	Data Type	Required
Id	body	int	No
ActionType	body	IncentiveActionType	No
Description	body	string	No
Page	body	string	No
Segment	body	string	No
Element	body	string	No
LicenseTypeId	body	int?	No

**IncentiveActionType** Enum:
Name	Value
Upgrade	1
AddOn	2
Information	3

**IncentiveActionResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
ActionType	form	IncentiveActionType	No
Page	form	string	No
Segment	form	string	No
Element	form	string	No
LicenseTypeId	form	int?	No
SuggestedLicenseToUpgrade	form	LicenseTypeQueryResponse	No

**LicenseTypeQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The license type id
Name	form	string	No	The license type name
Description	form	string	No	The license type description
IsExtraLicenseOption	form	bool	No	If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
PeriodOfNoticeDays	form	int	No	The period of notice for the license in days.
Items	form	List<LicenseItemsResponse>	No	The license items for the license type
Prices	form	List<LicensePrice>	No	The license prices in each country for the license type

**LicenseItemsResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
AllowedItems	form	int	No

**LicensePrice** Parameters:
Name	Parameter	Data Type	Required
Country	form	Country	No
MonthlyPayment	form	bool	No
LicenseTypeId	form	int	Yes
CountryId	form	string	Yes
Price	form	int	Yes
ModifiedDate	form	DateTimeOffset?	No

**Country** Parameters:
Name	Parameter	Data Type	Required
CurrencyId	form	string	No
CurrencyInfo	form	Currency	No
Name	form	string	Yes
Culture	form	string	No
TimeZone	form	string	No
ModifiedDate	form	DateTimeOffset?	No
Id	form	string	Yes

**Currency** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
CurrencySign	form	string	Yes
Active	form	bool	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	string	Yes

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /superadmin/incentives/action HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	ActionType: Upgrade,
	Description: String,
	Page: String,
	Segment: String,
	Element: String,
	LicenseTypeId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Description: String,
	ActionType: Upgrade,
	Page: String,
	Segment: String,
	Element: String,
	LicenseTypeId: 0,
	SuggestedLicenseToUpgrade: 
	{
		Id: 0,
		Name: String,
		Description: String,
		IsExtraLicenseOption: False,
		PeriodOfNoticeDays: 0,
		Items: 
		[
			{
				Id: 0,
				Name: String,
				AllowedItems: 0
			}
		],
		Prices: 
		[
			{
				Country: 
				{
					CurrencyId: String,
					CurrencyInfo: 
					{
						Name: String,
						CurrencySign: String,
						Active: False,
						ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
						Id: String
					},
					Name: String,
					Culture: String,
					TimeZone: String,
					ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
					Id: String
				},
				MonthlyPayment: True,
				LicenseTypeId: 0,
				CountryId: String,
				Price: 0,
				ModifiedDate: 0001-01-01T00:00:00.0000000+00:00
			}
		]
	}
}