BokaMera.API.Host

CreateIncentiveAction

**Requires Authentication**
Requires the role:	superadmin

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

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    public static class CreateIncentiveAction
    {
        public Integer Id = null;
        public IncentiveActionType ActionType = null;
        public String Description = null;
        public String Page = null;
        public String Segment = null;
        public String Element = null;
        public Integer LicenseTypeId = null;
        
        public Integer getId() { return Id; }
        public CreateIncentiveAction setId(Integer value) { this.Id = value; return this; }
        public IncentiveActionType getActionType() { return ActionType; }
        public CreateIncentiveAction setActionType(IncentiveActionType value) { this.ActionType = value; return this; }
        public String getDescription() { return Description; }
        public CreateIncentiveAction setDescription(String value) { this.Description = value; return this; }
        public String getPage() { return Page; }
        public CreateIncentiveAction setPage(String value) { this.Page = value; return this; }
        public String getSegment() { return Segment; }
        public CreateIncentiveAction setSegment(String value) { this.Segment = value; return this; }
        public String getElement() { return Element; }
        public CreateIncentiveAction setElement(String value) { this.Element = value; return this; }
        public Integer getLicenseTypeId() { return LicenseTypeId; }
        public CreateIncentiveAction setLicenseTypeId(Integer value) { this.LicenseTypeId = value; return this; }
    }

    public static enum IncentiveActionType
    {
        Upgrade(1),
        AddOn(2),
        Information(3);

        private final int value;
        IncentiveActionType(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class IncentiveActionResponse
    {
        public Integer Id = null;
        public String Description = null;
        public IncentiveActionType ActionType = null;
        public String Page = null;
        public String Segment = null;
        public String Element = null;
        public Integer LicenseTypeId = null;
        public LicenseTypeQueryResponse SuggestedLicenseToUpgrade = null;
        
        public Integer getId() { return Id; }
        public IncentiveActionResponse setId(Integer value) { this.Id = value; return this; }
        public String getDescription() { return Description; }
        public IncentiveActionResponse setDescription(String value) { this.Description = value; return this; }
        public IncentiveActionType getActionType() { return ActionType; }
        public IncentiveActionResponse setActionType(IncentiveActionType value) { this.ActionType = value; return this; }
        public String getPage() { return Page; }
        public IncentiveActionResponse setPage(String value) { this.Page = value; return this; }
        public String getSegment() { return Segment; }
        public IncentiveActionResponse setSegment(String value) { this.Segment = value; return this; }
        public String getElement() { return Element; }
        public IncentiveActionResponse setElement(String value) { this.Element = value; return this; }
        public Integer getLicenseTypeId() { return LicenseTypeId; }
        public IncentiveActionResponse setLicenseTypeId(Integer value) { this.LicenseTypeId = value; return this; }
        public LicenseTypeQueryResponse getSuggestedLicenseToUpgrade() { return SuggestedLicenseToUpgrade; }
        public IncentiveActionResponse setSuggestedLicenseToUpgrade(LicenseTypeQueryResponse value) { this.SuggestedLicenseToUpgrade = value; return this; }
    }

    public static class LicenseTypeQueryResponse
    {
        /**
        * The license type id
        */
        @ApiMember(Description="The license type id")
        public Integer Id = null;

        /**
        * The license type name
        */
        @ApiMember(Description="The license type name")
        public String Name = null;

        /**
        * The license type description
        */
        @ApiMember(Description="The license type description")
        public String Description = null;

        /**
        * If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
        */
        @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 Boolean IsExtraLicenseOption = null;

        /**
        * The period of notice for the license in days.
        */
        @ApiMember(Description="The period of notice for the license in days.")
        public Integer PeriodOfNoticeDays = null;

        /**
        * The license items for the license type
        */
        @ApiMember(Description="The license items for the license type")
        public ArrayList<LicenseItemsResponse> Items = null;

        /**
        * The license prices in each country for the license type
        */
        @ApiMember(Description="The license prices in each country for the license type")
        public ArrayList<LicensePrice> Prices = null;
        
        public Integer getId() { return Id; }
        public LicenseTypeQueryResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public LicenseTypeQueryResponse setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public LicenseTypeQueryResponse setDescription(String value) { this.Description = value; return this; }
        public Boolean getIsExtraLicenseOption() { return IsExtraLicenseOption; }
        public LicenseTypeQueryResponse setIsExtraLicenseOption(Boolean value) { this.IsExtraLicenseOption = value; return this; }
        public Integer getPeriodOfNoticeDays() { return PeriodOfNoticeDays; }
        public LicenseTypeQueryResponse setPeriodOfNoticeDays(Integer value) { this.PeriodOfNoticeDays = value; return this; }
        public ArrayList<LicenseItemsResponse> getItems() { return Items; }
        public LicenseTypeQueryResponse setItems(ArrayList<LicenseItemsResponse> value) { this.Items = value; return this; }
        public ArrayList<LicensePrice> getPrices() { return Prices; }
        public LicenseTypeQueryResponse setPrices(ArrayList<LicensePrice> value) { this.Prices = value; return this; }
    }

    public static class LicenseItemsResponse
    {
        public Integer Id = null;
        public String Name = null;
        public Integer AllowedItems = null;
        
        public Integer getId() { return Id; }
        public LicenseItemsResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public LicenseItemsResponse setName(String value) { this.Name = value; return this; }
        public Integer getAllowedItems() { return AllowedItems; }
        public LicenseItemsResponse setAllowedItems(Integer value) { this.AllowedItems = value; return this; }
    }

    public static class LicensePrice extends BaseModel
    {
        @Ignore()
        public Country Country = null;

        @Ignore()
        public Boolean MonthlyPayment = null;

        @Required()
        public Integer LicenseTypeId = null;

        @Required()
        public String CountryId = null;

        @Required()
        public Integer Price = null;

        public Date ModifiedDate = null;
        
        public Country getCountry() { return Country; }
        public LicensePrice setCountry(Country value) { this.Country = value; return this; }
        public Boolean isMonthlyPayment() { return MonthlyPayment; }
        public LicensePrice setMonthlyPayment(Boolean value) { this.MonthlyPayment = value; return this; }
        public Integer getLicenseTypeId() { return LicenseTypeId; }
        public LicensePrice setLicenseTypeId(Integer value) { this.LicenseTypeId = value; return this; }
        public String getCountryId() { return CountryId; }
        public LicensePrice setCountryId(String value) { this.CountryId = value; return this; }
        public Integer getPrice() { return Price; }
        public LicensePrice setPrice(Integer value) { this.Price = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public LicensePrice setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
    }

    public static class BaseModel
    {
        
    }

    public static class Country extends BaseModel
    {
        @References(Currency.class)
        public String CurrencyId = null;

        public Currency CurrencyInfo = null;
        @Required()
        public String Name = null;

        public String Culture = null;
        public String TimeZone = null;
        public Date ModifiedDate = null;
        @Required()
        public String Id = null;
        
        public String getCurrencyId() { return CurrencyId; }
        public Country setCurrencyId(String value) { this.CurrencyId = value; return this; }
        public Currency getCurrencyInfo() { return CurrencyInfo; }
        public Country setCurrencyInfo(Currency value) { this.CurrencyInfo = value; return this; }
        public String getName() { return Name; }
        public Country setName(String value) { this.Name = value; return this; }
        public String getCulture() { return Culture; }
        public Country setCulture(String value) { this.Culture = value; return this; }
        public String getTimeZone() { return TimeZone; }
        public Country setTimeZone(String value) { this.TimeZone = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public Country setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
        public String getId() { return Id; }
        public Country setId(String value) { this.Id = value; return this; }
    }

    public static class Currency extends BaseModel
    {
        @Required()
        public String Name = null;

        @Required()
        public String CurrencySign = null;

        @Required()
        public Boolean Active = null;

        public Date ModifiedDate = null;
        @Required()
        public String Id = null;
        
        public String getName() { return Name; }
        public Currency setName(String value) { this.Name = value; return this; }
        public String getCurrencySign() { return CurrencySign; }
        public Currency setCurrencySign(String value) { this.CurrencySign = value; return this; }
        public Boolean isActive() { return Active; }
        public Currency setActive(Boolean value) { this.Active = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public Currency setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
        public String getId() { return Id; }
        public Currency setId(String value) { this.Id = value; return this; }
    }

}

Java CreateIncentiveAction DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /superadmin/incentives/action HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateIncentiveAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ActionType>Upgrade</ActionType>
  <Description>String</Description>
  <Element>String</Element>
  <Id>0</Id>
  <LicenseTypeId>0</LicenseTypeId>
  <Page>String</Page>
  <Segment>String</Segment>
</CreateIncentiveAction>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IncentiveActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ActionType>Upgrade</ActionType>
  <Description>String</Description>
  <Element>String</Element>
  <Id>0</Id>
  <LicenseTypeId>0</LicenseTypeId>
  <Page>String</Page>
  <Segment>String</Segment>
  <SuggestedLicenseToUpgrade>
    <Description>String</Description>
    <Id>0</Id>
    <IsExtraLicenseOption>false</IsExtraLicenseOption>
    <Items>
      <LicenseItemsResponse>
        <AllowedItems>0</AllowedItems>
        <Id>0</Id>
        <Name>String</Name>
      </LicenseItemsResponse>
    </Items>
    <Name>String</Name>
    <PeriodOfNoticeDays>0</PeriodOfNoticeDays>
    <Prices xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
      <d3p1:LicensePrice>
        <d3p1:Country>
          <d3p1:Culture>String</d3p1:Culture>
          <d3p1:CurrencyId>String</d3p1:CurrencyId>
          <d3p1:CurrencyInfo>
            <d3p1:Active>false</d3p1:Active>
            <d3p1:CurrencySign>String</d3p1:CurrencySign>
            <d3p1:Id>String</d3p1:Id>
            <d3p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
              <d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
              <d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
            </d3p1:ModifiedDate>
            <d3p1:Name>String</d3p1:Name>
          </d3p1:CurrencyInfo>
          <d3p1:Id>String</d3p1:Id>
          <d3p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </d3p1:ModifiedDate>
          <d3p1:Name>String</d3p1:Name>
          <d3p1:TimeZone>String</d3p1:TimeZone>
        </d3p1:Country>
        <d3p1:CountryId>String</d3p1:CountryId>
        <d3p1:LicenseTypeId>0</d3p1:LicenseTypeId>
        <d3p1:ModifiedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </d3p1:ModifiedDate>
        <d3p1:Price>0</d3p1:Price>
      </d3p1:LicensePrice>
    </Prices>
  </SuggestedLicenseToUpgrade>
</IncentiveActionResponse>