BokaMera.API.Host

CreateIncentive

**Requires Authentication**
Requires the role:	superadmin

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

**CreateIncentive** Parameters:
Name	Parameter	Data Type	Required
Heading	body	string	Yes
StorageUrl	body	string	No
Body	body	string	No
SuccessButtonText	body	string	Yes
ActionId	body	int	Yes
Frequency	body	IncentiveRecurrenceFrequency	Yes
RecurrenceInterval	body	uint	No
InitialDelayInSeconds	body	int	Yes
MaxDisplayCount	body	int?	Yes
ValidFrom	body	DateTimeOffset	Yes
ValidTo	body	DateTimeOffset	Yes
Active	body	bool	No
Payload	body	string	No
CompanyIds	body	List<Guid>	No
Criteria	body	List<IncentiveCriteriaDto>	No

**IncentiveRecurrenceFrequency** Enum:
Name	Value
OneTime	1
Weekly	2
Monthly	3

**IncentiveCriteriaDto** Parameters:
Name	Parameter	Data Type	Required
CriteriaType	form	CriteriaType	No
Value	form	string	No
InvertCondition	form	bool	No

**CriteriaType** Enum:
LicenseAvailability
SmsActivation
eAccountingActivation
CodeLockActivation
SocialActivation
OnlinePaymentActivation
FollowUpMessageActivation
RatingActivation

**AdminIncentiveQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Frequency	form	IncentiveRecurrenceFrequency	No
RecurrenceInterval	form	uint	No
CreatedDate	form	DateTimeOffset	No
ModifiedDate	form	DateTimeOffset	No
CompanyIds	form	List<Guid>	No
Criteria	form	List<IncentiveCriteria>	No
ApplyToAllCompanies	form	bool	No

**CompanyIncentiveResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Heading	form	string	No
StorageUrl	form	string	No
SuccessButtonText	form	string	No
ActionId	form	int	No
InitialDelayInSeconds	form	int	No
MaxDisplayCount	form	int?	No
ValidFrom	form	DateTimeOffset	No
ValidTo	form	DateTimeOffset	No
Action	form	IncentiveActionResponse	No
Payload	form	string	No

**IncentiveActionResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	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

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

**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<LicensePriceResponse>	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

**LicensePriceResponse** Parameters:
Name	Parameter	Data Type	Required
LicenseTypeId	form	int	No
CountryId	form	string	No
Price	form	int	No
Country	form	Country	No
LicensePlanId	form	int	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

**IncentiveCriteria** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
IncentiveId	form	int	No
CriteriaType	form	CriteriaType	No
Value	form	string	No
InvertCondition	form	bool	No
CreatedDate	form	DateTimeOffset	No

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 HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Heading: String,
	StorageUrl: String,
	Body: String,
	SuccessButtonText: String,
	ActionId: 0,
	Frequency: OneTime,
	RecurrenceInterval: 0,
	InitialDelayInSeconds: 0,
	MaxDisplayCount: 0,
	ValidFrom: 0001-01-01T00:00:00.0000000+00:00,
	ValidTo: 0001-01-01T00:00:00.0000000+00:00,
	Active: False,
	Payload: String,
	CompanyIds: 
	[
		00000000-0000-0000-0000-000000000000
	],
	Criteria: 
	[
		{
			CriteriaType: LicenseAvailability,
			Value: String,
			InvertCondition: False
		}
	]
}

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

{
	Frequency: OneTime,
	RecurrenceInterval: 0,
	CreatedDate: 0001-01-01T00:00:00.0000000+00:00,
	ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
	CompanyIds: 
	[
		00000000-0000-0000-0000-000000000000
	],
	Criteria: 
	[
		{
			Id: 0,
			IncentiveId: 0,
			CriteriaType: LicenseAvailability,
			Value: String,
			InvertCondition: False,
			CreatedDate: 0001-01-01T00:00:00.0000000+00:00
		}
	],
	ApplyToAllCompanies: False,
	Id: 0,
	Heading: String,
	StorageUrl: String,
	SuccessButtonText: String,
	ActionId: 0,
	InitialDelayInSeconds: 0,
	MaxDisplayCount: 0,
	ValidFrom: 0001-01-01T00:00:00.0000000+00:00,
	ValidTo: 0001-01-01T00:00:00.0000000+00:00,
	Action: 
	{
		Id: 0,
		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: 
			[
				{
					LicenseTypeId: 0,
					CountryId: String,
					Price: 0,
					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
					},
					LicensePlanId: 0
				}
			]
		}
	},
	Payload: String
}