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


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

export class LicenseItemsResponse
{
    public Id: number;
    public Name: string;
    public AllowedItems: number;

    public constructor(init?: Partial<LicenseItemsResponse>) { (Object as any).assign(this, init); }
}

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class Currency extends BaseModel
{
    // @Required()
    public Name: string;

    // @Required()
    public CurrencySign: string;

    // @Required()
    public Active: boolean;

    public ModifiedDate?: string;
    // @Required()
    public Id: string;

    public constructor(init?: Partial<Currency>) { super(init); (Object as any).assign(this, init); }
}

export class Country extends BaseModel
{
    // @References("typeof(BokaMera.API.ServiceModel.Db.Currency)")
    public CurrencyId: string;

    public CurrencyInfo: Currency;
    // @Required()
    public Name: string;

    public Culture: string;
    public TimeZone: string;
    public ModifiedDate?: string;
    // @Required()
    public Id: string;

    public constructor(init?: Partial<Country>) { super(init); (Object as any).assign(this, init); }
}

export class LicensePrice extends BaseModel
{
    // @Ignore()
    public Country: Country;

    // @Ignore()
    public MonthlyPayment: boolean;

    // @Required()
    public LicenseTypeId: number;

    // @Required()
    public CountryId: string;

    // @Required()
    public Price: number;

    public ModifiedDate?: string;

    public constructor(init?: Partial<LicensePrice>) { super(init); (Object as any).assign(this, init); }
}

export class LicenseTypeQueryResponse
{
    /** @description The license type id */
    // @ApiMember(Description="The license type id")
    public Id: number;

    /** @description The license type name */
    // @ApiMember(Description="The license type name")
    public Name: string;

    /** @description The license type description */
    // @ApiMember(Description="The license type description")
    public Description: string;

    /** @description 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 IsExtraLicenseOption: boolean;

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

    /** @description The license items for the license type */
    // @ApiMember(Description="The license items for the license type")
    public Items: LicenseItemsResponse[];

    /** @description The license prices in each country for the license type */
    // @ApiMember(Description="The license prices in each country for the license type")
    public Prices: LicensePrice[];

    public constructor(init?: Partial<LicenseTypeQueryResponse>) { (Object as any).assign(this, init); }
}

export class IncentiveActionResponse
{
    public Id: number;
    public Description: string;
    public ActionType: IncentiveActionType;
    public Page: string;
    public Segment: string;
    public Element: string;
    public LicenseTypeId?: number;
    public SuggestedLicenseToUpgrade: LicenseTypeQueryResponse;

    public constructor(init?: Partial<IncentiveActionResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class CreateIncentiveAction
{
    public Id: number;
    public ActionType: IncentiveActionType;
    public Description: string;
    public Page: string;
    public Segment: string;
    public Element: string;
    public LicenseTypeId?: number;

    public constructor(init?: Partial<CreateIncentiveAction>) { (Object as any).assign(this, init); }
}

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