| Requires the role: | superadmin |
| GET | /superadmin/incentives/ | Query incentives |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract
abstract class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
// @DataMember(Order=1)
int? Skip;
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
// @DataMember(Order=2)
int? Take;
/**
* 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.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
// @DataMember(Order=3)
String? OrderBy;
/**
* 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.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
// @DataMember(Order=4)
String? OrderByDesc;
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
// @DataMember(Order=5)
String? Include;
// @DataMember(Order=6)
String? Fields;
// @DataMember(Order=7)
Map<String,String?>? Meta;
QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Skip = json['Skip'];
Take = json['Take'];
OrderBy = json['OrderBy'];
OrderByDesc = json['OrderByDesc'];
Include = json['Include'];
Fields = json['Fields'];
Meta = JsonConverters.toStringMap(json['Meta']);
return this;
}
Map<String, dynamic> toJson() => {
'Skip': Skip,
'Take': Take,
'OrderBy': OrderBy,
'OrderByDesc': OrderByDesc,
'Include': Include,
'Fields': Fields,
'Meta': Meta
};
getTypeName() => "QueryBase";
TypeContext? context = _ctx;
}
abstract class QueryDb2<From,Into> extends QueryBase
{
QueryDb2();
QueryDb2.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "QueryDb<$From,$Into>";
TypeContext? context = _ctx;
}
class BaseModel implements IConvertible
{
BaseModel();
BaseModel.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "BaseModel";
TypeContext? context = _ctx;
}
enum IncentiveRecurrenceFrequency
{
OneTime,
Weekly,
Monthly,
}
class IncentiveCompanyRelation extends BaseModel implements IConvertible
{
int? Id;
String? CompanyId;
int? IncentiveId;
DateTime? CreatedDate;
IncentiveCompanyRelation({this.Id,this.CompanyId,this.IncentiveId,this.CreatedDate});
IncentiveCompanyRelation.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Id = json['Id'];
CompanyId = json['CompanyId'];
IncentiveId = json['IncentiveId'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Id': Id,
'CompanyId': CompanyId,
'IncentiveId': IncentiveId,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!)
});
getTypeName() => "IncentiveCompanyRelation";
TypeContext? context = _ctx;
}
enum CriteriaType
{
LicenseAvailability,
SmsActivation,
eAccountingActivation,
CodeLockActivation,
SocialActivation,
OnlinePaymentActivation,
FollowUpMessageActivation,
RatingActivation,
}
class IncentiveCriteria extends BaseModel implements IConvertible
{
int? Id;
int? IncentiveId;
CriteriaType? CriteriaType;
String? Value;
bool? InvertCondition;
DateTime? CreatedDate;
IncentiveCriteria({this.Id,this.IncentiveId,this.CriteriaType,this.Value,this.InvertCondition,this.CreatedDate});
IncentiveCriteria.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Id = json['Id'];
IncentiveId = json['IncentiveId'];
CriteriaType = JsonConverters.fromJson(json['CriteriaType'],'CriteriaType',context!);
Value = json['Value'];
InvertCondition = json['InvertCondition'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Id': Id,
'IncentiveId': IncentiveId,
'CriteriaType': JsonConverters.toJson(CriteriaType,'CriteriaType',context!),
'Value': Value,
'InvertCondition': InvertCondition,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!)
});
getTypeName() => "IncentiveCriteria";
TypeContext? context = _ctx;
}
enum IncentiveActionType
{
Upgrade,
AddOn,
Information,
}
class IncentiveAction extends BaseModel implements IConvertible
{
int? Id;
IncentiveActionType? ActionType;
String? Page;
String? Segment;
String? Element;
int? LicenseTypeId;
IncentiveAction({this.Id,this.ActionType,this.Page,this.Segment,this.Element,this.LicenseTypeId});
IncentiveAction.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Id = json['Id'];
ActionType = JsonConverters.fromJson(json['ActionType'],'IncentiveActionType',context!);
Page = json['Page'];
Segment = json['Segment'];
Element = json['Element'];
LicenseTypeId = json['LicenseTypeId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Id': Id,
'ActionType': JsonConverters.toJson(ActionType,'IncentiveActionType',context!),
'Page': Page,
'Segment': Segment,
'Element': Element,
'LicenseTypeId': LicenseTypeId
});
getTypeName() => "IncentiveAction";
TypeContext? context = _ctx;
}
class Incentive extends BaseModel implements IConvertible
{
int? Id;
String? Heading;
String? StorageUrl;
String? SuccessButtonText;
bool? Active;
int? ActionId;
IncentiveRecurrenceFrequency? Frequency;
int? RecurrenceInterval;
int? InitialDelayInSeconds;
int? MaxDisplayCount;
DateTime? ValidFrom;
DateTime? ValidTo;
DateTime? CreatedDate;
DateTime? ModifiedDate;
bool? AppliesToAllCompanies;
String? Payload;
List<IncentiveCompanyRelation>? Companies;
List<IncentiveCriteria>? Criteria;
// @Ignore()
IncentiveAction? Action;
Incentive({this.Id,this.Heading,this.StorageUrl,this.SuccessButtonText,this.Active,this.ActionId,this.Frequency,this.RecurrenceInterval,this.InitialDelayInSeconds,this.MaxDisplayCount,this.ValidFrom,this.ValidTo,this.CreatedDate,this.ModifiedDate,this.AppliesToAllCompanies,this.Payload,this.Companies,this.Criteria,this.Action});
Incentive.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Id = json['Id'];
Heading = json['Heading'];
StorageUrl = json['StorageUrl'];
SuccessButtonText = json['SuccessButtonText'];
Active = json['Active'];
ActionId = json['ActionId'];
Frequency = JsonConverters.fromJson(json['Frequency'],'IncentiveRecurrenceFrequency',context!);
RecurrenceInterval = json['RecurrenceInterval'];
InitialDelayInSeconds = json['InitialDelayInSeconds'];
MaxDisplayCount = json['MaxDisplayCount'];
ValidFrom = JsonConverters.fromJson(json['ValidFrom'],'DateTime',context!);
ValidTo = JsonConverters.fromJson(json['ValidTo'],'DateTime',context!);
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
AppliesToAllCompanies = json['AppliesToAllCompanies'];
Payload = json['Payload'];
Companies = JsonConverters.fromJson(json['Companies'],'List<IncentiveCompanyRelation>',context!);
Criteria = JsonConverters.fromJson(json['Criteria'],'List<IncentiveCriteria>',context!);
Action = JsonConverters.fromJson(json['Action'],'IncentiveAction',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Id': Id,
'Heading': Heading,
'StorageUrl': StorageUrl,
'SuccessButtonText': SuccessButtonText,
'Active': Active,
'ActionId': ActionId,
'Frequency': JsonConverters.toJson(Frequency,'IncentiveRecurrenceFrequency',context!),
'RecurrenceInterval': RecurrenceInterval,
'InitialDelayInSeconds': InitialDelayInSeconds,
'MaxDisplayCount': MaxDisplayCount,
'ValidFrom': JsonConverters.toJson(ValidFrom,'DateTime',context!),
'ValidTo': JsonConverters.toJson(ValidTo,'DateTime',context!),
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'AppliesToAllCompanies': AppliesToAllCompanies,
'Payload': Payload,
'Companies': JsonConverters.toJson(Companies,'List<IncentiveCompanyRelation>',context!),
'Criteria': JsonConverters.toJson(Criteria,'List<IncentiveCriteria>',context!),
'Action': JsonConverters.toJson(Action,'IncentiveAction',context!)
});
getTypeName() => "Incentive";
TypeContext? context = _ctx;
}
// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class AdminIncentivesQuery extends QueryDb2<Incentive,QueryResponse<AdminIncentiveQueryResponse>> implements IConvertible
{
int? Id;
String? CompanyId;
Date? ValidFrom;
Date? ValidTo;
int? ActionId;
bool? Active;
bool? IncludeCriteria;
bool? IncludeCompanies;
bool? IncludeAction;
AdminIncentivesQuery({this.Id,this.CompanyId,this.ValidFrom,this.ValidTo,this.ActionId,this.Active,this.IncludeCriteria,this.IncludeCompanies,this.IncludeAction});
AdminIncentivesQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Id = json['Id'];
CompanyId = json['CompanyId'];
ValidFrom = JsonConverters.fromJson(json['ValidFrom'],'Date',context!);
ValidTo = JsonConverters.fromJson(json['ValidTo'],'Date',context!);
ActionId = json['ActionId'];
Active = json['Active'];
IncludeCriteria = json['IncludeCriteria'];
IncludeCompanies = json['IncludeCompanies'];
IncludeAction = json['IncludeAction'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Id': Id,
'CompanyId': CompanyId,
'ValidFrom': JsonConverters.toJson(ValidFrom,'Date',context!),
'ValidTo': JsonConverters.toJson(ValidTo,'Date',context!),
'ActionId': ActionId,
'Active': Active,
'IncludeCriteria': IncludeCriteria,
'IncludeCompanies': IncludeCompanies,
'IncludeAction': IncludeAction
});
getTypeName() => "AdminIncentivesQuery";
TypeContext? context = _ctx;
}
class AccessKeyTypeResponse implements IConvertible
{
int? Id;
String? KeyType;
String? Description;
AccessKeyTypeResponse({this.Id,this.KeyType,this.Description});
AccessKeyTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
KeyType = json['KeyType'];
Description = json['Description'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'KeyType': KeyType,
'Description': Description
};
getTypeName() => "AccessKeyTypeResponse";
TypeContext? context = _ctx;
}
// @DataContract
class QueryResponse<AccessKeyTypeResponse> implements IConvertible
{
// @DataMember(Order=1)
int? Offset;
// @DataMember(Order=2)
int? Total;
// @DataMember(Order=3)
List<AccessKeyTypeResponse>? Results;
// @DataMember(Order=4)
Map<String,String?>? Meta;
// @DataMember(Order=5)
ResponseStatus? ResponseStatus;
QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Offset = json['Offset'];
Total = json['Total'];
Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
Meta = JsonConverters.toStringMap(json['Meta']);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Offset': Offset,
'Total': Total,
'Results': JsonConverters.toJson(Results,'List<AccessKeyTypeResponse>',context!),
'Meta': Meta,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryResponse<$AccessKeyTypeResponse>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'IncentiveRecurrenceFrequency': TypeInfo(TypeOf.Enum, enumValues:IncentiveRecurrenceFrequency.values),
'IncentiveCompanyRelation': TypeInfo(TypeOf.Class, create:() => IncentiveCompanyRelation()),
'CriteriaType': TypeInfo(TypeOf.Enum, enumValues:CriteriaType.values),
'IncentiveCriteria': TypeInfo(TypeOf.Class, create:() => IncentiveCriteria()),
'IncentiveActionType': TypeInfo(TypeOf.Enum, enumValues:IncentiveActionType.values),
'IncentiveAction': TypeInfo(TypeOf.Class, create:() => IncentiveAction()),
'Incentive': TypeInfo(TypeOf.Class, create:() => Incentive()),
'List<IncentiveCompanyRelation>': TypeInfo(TypeOf.Class, create:() => <IncentiveCompanyRelation>[]),
'List<IncentiveCriteria>': TypeInfo(TypeOf.Class, create:() => <IncentiveCriteria>[]),
'AdminIncentivesQuery': TypeInfo(TypeOf.Class, create:() => AdminIncentivesQuery()),
'List<QueryResponse<AdminIncentiveQueryResponse>>': TypeInfo(TypeOf.Class, create:() => <QueryResponse<AdminIncentiveQueryResponse>>[]),
'Date': TypeInfo(TypeOf.Class, create:() => Date()),
'AccessKeyTypeResponse': TypeInfo(TypeOf.Class, create:() => AccessKeyTypeResponse()),
'QueryResponse<AccessKeyTypeResponse>': TypeInfo(TypeOf.Class, create:() => QueryResponse<AccessKeyTypeResponse>()),
});
Dart AdminIncentivesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}