| Requires the role: | superadmin |
| GET | /superadmin/incentives/ | Query incentives |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db.Incentive;
using BokaMera.API.ServiceModel.Db;
namespace BokaMera.API.ServiceModel.Db
{
public partial class BaseModel
{
}
}
namespace BokaMera.API.ServiceModel.Db.Incentive
{
public enum CriteriaType
{
LicenseAvailability,
SmsActivation,
eAccountingActivation,
CodeLockActivation,
SocialActivation,
OnlinePaymentActivation,
FollowUpMessageActivation,
RatingActivation,
}
public partial class Incentive
: BaseModel
{
public Incentive()
{
Companies = new List<IncentiveCompanyRelation>{};
Criteria = new List<IncentiveCriteria>{};
}
public virtual int Id { get; set; }
public virtual string Heading { get; set; }
public virtual string StorageUrl { get; set; }
public virtual string SuccessButtonText { get; set; }
public virtual bool Active { get; set; }
public virtual int ActionId { get; set; }
public virtual IncentiveRecurrenceFrequency Frequency { get; set; }
public virtual uint RecurrenceInterval { get; set; }
public virtual int InitialDelayInSeconds { get; set; }
public virtual int? MaxDisplayCount { get; set; }
public virtual DateTimeOffset ValidFrom { get; set; }
public virtual DateTimeOffset ValidTo { get; set; }
public virtual DateTimeOffset CreatedDate { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
public virtual bool AppliesToAllCompanies { get; set; }
public virtual string Payload { get; set; }
public virtual List<IncentiveCompanyRelation> Companies { get; set; }
public virtual List<IncentiveCriteria> Criteria { get; set; }
[Ignore]
public virtual IncentiveAction Action { get; set; }
}
public partial class IncentiveAction
: BaseModel
{
public virtual int Id { get; set; }
public virtual IncentiveActionType ActionType { get; set; }
public virtual string Page { get; set; }
public virtual string Segment { get; set; }
public virtual string Element { get; set; }
public virtual int? LicenseTypeId { get; set; }
}
public enum IncentiveActionType
{
Upgrade = 1,
AddOn = 2,
Information = 3,
}
public partial class IncentiveCompanyRelation
: BaseModel
{
public virtual long Id { get; set; }
public virtual Guid CompanyId { get; set; }
public virtual int IncentiveId { get; set; }
public virtual DateTimeOffset CreatedDate { get; set; }
}
public partial class IncentiveCriteria
: BaseModel
{
public virtual int Id { get; set; }
public virtual int IncentiveId { get; set; }
public virtual CriteriaType CriteriaType { get; set; }
public virtual string Value { get; set; }
public virtual bool InvertCondition { get; set; }
public virtual DateTimeOffset CreatedDate { get; set; }
}
public enum IncentiveRecurrenceFrequency
{
OneTime = 1,
Weekly = 2,
Monthly = 3,
}
}
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AccessKeyTypeResponse
{
public virtual int Id { get; set; }
public virtual string KeyType { get; set; }
public virtual string Description { get; set; }
}
[ValidateRequest("IsAuthenticated")]
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
public partial class AdminIncentivesQuery
: QueryDb<Incentive, QueryResponse<AdminIncentiveQueryResponse>>
{
public virtual int? Id { get; set; }
public virtual Guid? CompanyId { get; set; }
public virtual Date? ValidFrom { get; set; }
public virtual Date? ValidTo { get; set; }
public virtual int? ActionId { get; set; }
public virtual bool? Active { get; set; }
public virtual bool IncludeCriteria { get; set; }
public virtual bool IncludeCompanies { get; set; }
public virtual bool IncludeAction { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
///<summary>
///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>
///</summary>
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=2)]
public virtual int? Take { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=5)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<From, Into>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<AccessKeyTypeResponse>
{
public QueryResponse()
{
Results = new List<AccessKeyTypeResponse>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<AccessKeyTypeResponse> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}