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

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
    {
    }

    public partial class Country
        : BaseModel
    {
        [References(typeof(BokaMera.API.ServiceModel.Db.Currency))]
        public virtual string CurrencyId { get; set; }

        public virtual Currency CurrencyInfo { get; set; }
        [Required]
        public virtual string Name { get; set; }

        public virtual string Culture { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual DateTimeOffset? ModifiedDate { get; set; }
        [Required]
        public virtual string Id { get; set; }
    }

    public partial class Currency
        : BaseModel
    {
        [Required]
        public virtual string Name { get; set; }

        [Required]
        public virtual string CurrencySign { get; set; }

        [Required]
        public virtual bool Active { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
        [Required]
        public virtual string Id { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Db.Incentive
{
    public enum CriteriaType
    {
        LicenseAvailability,
        SmsActivation,
        eAccountingActivation,
        CodeLockActivation,
        SocialActivation,
        OnlinePaymentActivation,
        FollowUpMessageActivation,
        RatingActivation,
    }

    public enum IncentiveActionType
    {
        Upgrade = 1,
        AddOn = 2,
        Information = 3,
    }

    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 AdminIncentiveQueryResponse
        : CompanyIncentiveResponse
    {
        public AdminIncentiveQueryResponse()
        {
            CompanyIds = new List<Guid>{};
            Criteria = new List<IncentiveCriteria>{};
        }

        public virtual IncentiveRecurrenceFrequency Frequency { get; set; }
        public virtual uint RecurrenceInterval { get; set; }
        public virtual DateTimeOffset CreatedDate { get; set; }
        public virtual DateTimeOffset ModifiedDate { get; set; }
        public virtual List<Guid> CompanyIds { get; set; }
        public virtual List<IncentiveCriteria> Criteria { get; set; }
        public virtual bool ApplyToAllCompanies { get; set; }
    }

    public partial class CompanyIncentiveResponse
    {
        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 int ActionId { 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 IncentiveActionResponse Action { get; set; }
        public virtual string Payload { get; set; }
    }

    [ValidateRequest("IsAuthenticated")]
    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    public partial class CreateIncentive
    {
        public CreateIncentive()
        {
            CompanyIds = new List<Guid>{};
            Criteria = new List<IncentiveCriteriaDto>{};
        }

        [ApiMember(IsRequired=true)]
        public virtual string Heading { get; set; }

        [ApiMember]
        public virtual string StorageUrl { get; set; }

        [ApiMember]
        public virtual string Body { get; set; }

        [ApiMember(IsRequired=true)]
        public virtual string SuccessButtonText { get; set; }

        [ApiMember(IsRequired=true)]
        public virtual int ActionId { get; set; }

        [ApiMember(IsRequired=true)]
        public virtual IncentiveRecurrenceFrequency Frequency { get; set; }

        [ApiMember]
        public virtual uint RecurrenceInterval { get; set; }

        [ApiMember(IsRequired=true)]
        public virtual int InitialDelayInSeconds { get; set; }

        [ApiMember(IsRequired=true)]
        public virtual int? MaxDisplayCount { get; set; }

        [ApiMember(IsRequired=true)]
        public virtual DateTimeOffset ValidFrom { get; set; }

        [ApiMember(IsRequired=true)]
        public virtual DateTimeOffset ValidTo { get; set; }

        [ApiMember]
        public virtual bool Active { get; set; }

        [ApiMember]
        public virtual string Payload { get; set; }

        public virtual List<Guid> CompanyIds { get; set; }
        public virtual List<IncentiveCriteriaDto> Criteria { get; set; }
    }

    public partial class IncentiveActionResponse
    {
        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 virtual LicenseTypeQueryResponse SuggestedLicenseToUpgrade { get; set; }
    }

    public partial class IncentiveCriteriaDto
    {
        public virtual CriteriaType CriteriaType { get; set; }
        public virtual string Value { get; set; }
        public virtual bool InvertCondition { get; set; }
    }

    public partial class LicenseItemsResponse
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual int AllowedItems { get; set; }
    }

    public partial class LicensePriceResponse
    {
        public virtual int LicenseTypeId { get; set; }
        public virtual string CountryId { get; set; }
        public virtual int Price { get; set; }
        public virtual Country Country { get; set; }
        public virtual int LicensePlanId { get; set; }
    }

    public partial class LicenseTypeQueryResponse
    {
        public LicenseTypeQueryResponse()
        {
            Items = new List<LicenseItemsResponse>{};
            Prices = new List<LicensePriceResponse>{};
        }

        ///<summary>
        ///The license type id
        ///</summary>
        [ApiMember(Description="The license type id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The license type name
        ///</summary>
        [ApiMember(Description="The license type name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The license type description
        ///</summary>
        [ApiMember(Description="The license type description")]
        public virtual string Description { get; set; }

        ///<summary>
        ///If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
        ///</summary>
        [ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.")]
        public virtual bool IsExtraLicenseOption { get; set; }

        ///<summary>
        ///The period of notice for the license in days.
        ///</summary>
        [ApiMember(Description="The period of notice for the license in days.")]
        public virtual int PeriodOfNoticeDays { get; set; }

        ///<summary>
        ///The license items for the license type
        ///</summary>
        [ApiMember(Description="The license items for the license type")]
        public virtual List<LicenseItemsResponse> Items { get; set; }

        ///<summary>
        ///The license prices in each country for the license type
        ///</summary>
        [ApiMember(Description="The license prices in each country for the license type")]
        public virtual List<LicensePriceResponse> Prices { get; set; }
    }

}

C# CreateIncentive DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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"}