BokaMera.API.Host

AdminIncentivesQuery

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
GET	/superadmin/incentives/	Query incentives

**AdminIncentivesQuery** Parameters:
Name	Parameter	Data Type	Required
Id	query	int?	No
CompanyId	query	Guid?	No
ValidFrom	query	Date?	No
ValidTo	query	Date?	No
ActionId	query	int?	No
Active	query	bool?	No
IncludeCriteria	query	bool	No
IncludeCompanies	query	bool	No
IncludeAction	query	bool	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	query	int	No	Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging. Example: `?skip=10&orderBy=Id`
Take	query	int	No	Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: `?take=20`
OrderBy	query	string	No	Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: `?orderBy=Id,-Age,FirstName`
OrderByDesc	query	string	No	Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: `?orderByDesc=Id,-Age,FirstName`
Include	query	string	No	Include any of the aggregates `AVG, COUNT, FIRST, LAST, MAX, MIN, SUM` in your result set. The results will be returned in the meta field. Example: `?include=COUNT() as Total` or multiple fields with `?include=Count() Total, Min(Age), AVG(Age) AverageAge` or unique with `?include=COUNT(DISTINCT LivingStatus) as UniqueStatus`
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**Incentive** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Heading	form	string	No
StorageUrl	form	string	No
SuccessButtonText	form	string	No
Active	form	bool	No
ActionId	form	int	No
Frequency	form	IncentiveRecurrenceFrequency	No
RecurrenceInterval	form	uint	No
InitialDelayInSeconds	form	int	No
MaxDisplayCount	form	int?	No
ValidFrom	form	DateTimeOffset	No
ValidTo	form	DateTimeOffset	No
CreatedDate	form	DateTimeOffset	No
ModifiedDate	form	DateTimeOffset?	No
AppliesToAllCompanies	form	bool	No
Payload	form	string	No
Companies	form	List<IncentiveCompanyRelation>	No
Criteria	form	List<IncentiveCriteria>	No
Action	form	IncentiveAction	No

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

**IncentiveCompanyRelation** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
CompanyId	form	Guid	No
IncentiveId	form	int	No
CreatedDate	form	DateTimeOffset	No

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

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

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

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

**QueryResponse<AccessKeyTypeResponse>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	No
Description	form	string	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.

GET /superadmin/incentives/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

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

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Offset: 0,
			Total: 0,
			Results: 
			[
				{
					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
				}
			],
			Meta: 
			{
				String: String
			},
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: String,
						Meta: 
						{
							String: String
						}
					}
				],
				Meta: 
				{
					String: String
				}
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}