BokaMera.API.Host

<back to all web services

UpdateIncentive

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
PUT/superadmin/incentive/{id}Update incentive
"use strict";
/** @typedef {number} */
export var IncentiveActionType;
(function (IncentiveActionType) {
    IncentiveActionType[IncentiveActionType["Upgrade"] = 1] = "Upgrade"
    IncentiveActionType[IncentiveActionType["AddOn"] = 2] = "AddOn"
    IncentiveActionType[IncentiveActionType["Information"] = 3] = "Information"
})(IncentiveActionType || (IncentiveActionType = {}));
export class LicenseItemsResponse {
    /** @param {{Id?:number,Name?:string,AllowedItems?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {number} */
    AllowedItems;
}
export class BaseModel {
    constructor(init) { Object.assign(this, init) }
}
export class Currency extends BaseModel {
    /** @param {{Name?:string,CurrencySign?:string,Active?:boolean,ModifiedDate?:string,Id?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    CurrencySign;
    /** @type {boolean} */
    Active;
    /** @type {?string} */
    ModifiedDate;
    /** @type {string} */
    Id;
}
export class Country extends BaseModel {
    /** @param {{CurrencyId?:string,CurrencyInfo?:Currency,Name?:string,Culture?:string,TimeZone?:string,ModifiedDate?:string,Id?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    CurrencyId;
    /** @type {Currency} */
    CurrencyInfo;
    /** @type {string} */
    Name;
    /** @type {string} */
    Culture;
    /** @type {string} */
    TimeZone;
    /** @type {?string} */
    ModifiedDate;
    /** @type {string} */
    Id;
}
export class LicensePrice extends BaseModel {
    /** @param {{Country?:Country,MonthlyPayment?:boolean,LicenseTypeId?:number,CountryId?:string,Price?:number,ModifiedDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {Country} */
    Country;
    /** @type {boolean} */
    MonthlyPayment;
    /** @type {number} */
    LicenseTypeId;
    /** @type {string} */
    CountryId;
    /** @type {number} */
    Price;
    /** @type {?string} */
    ModifiedDate;
}
export class LicenseTypeQueryResponse {
    /** @param {{Id?:number,Name?:string,Description?:string,IsExtraLicenseOption?:boolean,PeriodOfNoticeDays?:number,Items?:LicenseItemsResponse[],Prices?:LicensePrice[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The license type id */
    Id;
    /**
     * @type {string}
     * @description The license type name */
    Name;
    /**
     * @type {string}
     * @description The license type description */
    Description;
    /**
     * @type {boolean}
     * @description If the license type is not a standard license but instead an extra license option. An example would be sending new letter license. */
    IsExtraLicenseOption;
    /**
     * @type {number}
     * @description The period of notice for the license in days. */
    PeriodOfNoticeDays;
    /**
     * @type {LicenseItemsResponse[]}
     * @description The license items for the license type */
    Items;
    /**
     * @type {LicensePrice[]}
     * @description The license prices in each country for the license type */
    Prices;
}
export class IncentiveActionResponse {
    /** @param {{Id?:number,Description?:string,ActionType?:IncentiveActionType,Page?:string,Segment?:string,Element?:string,LicenseTypeId?:number,SuggestedLicenseToUpgrade?:LicenseTypeQueryResponse}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Description;
    /** @type {IncentiveActionType} */
    ActionType;
    /** @type {string} */
    Page;
    /** @type {string} */
    Segment;
    /** @type {string} */
    Element;
    /** @type {?number} */
    LicenseTypeId;
    /** @type {LicenseTypeQueryResponse} */
    SuggestedLicenseToUpgrade;
}
export class CompanyIncentiveResponse {
    /** @param {{Id?:number,Heading?:string,StorageUrl?:string,SuccessButtonText?:string,ActionId?:number,InitialDelayInSeconds?:number,MaxDisplayCount?:number,ValidFrom?:string,ValidTo?:string,Action?:IncentiveActionResponse,Payload?:string,InitialDeferredDays?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Heading;
    /** @type {string} */
    StorageUrl;
    /** @type {string} */
    SuccessButtonText;
    /** @type {number} */
    ActionId;
    /** @type {number} */
    InitialDelayInSeconds;
    /** @type {?number} */
    MaxDisplayCount;
    /** @type {string} */
    ValidFrom;
    /** @type {string} */
    ValidTo;
    /** @type {IncentiveActionResponse} */
    Action;
    /** @type {string} */
    Payload;
    /** @type {number} */
    InitialDeferredDays;
}
/** @typedef {number} */
export var IncentiveRecurrenceFrequency;
(function (IncentiveRecurrenceFrequency) {
    IncentiveRecurrenceFrequency[IncentiveRecurrenceFrequency["OneTime"] = 1] = "OneTime"
    IncentiveRecurrenceFrequency[IncentiveRecurrenceFrequency["Weekly"] = 2] = "Weekly"
    IncentiveRecurrenceFrequency[IncentiveRecurrenceFrequency["Monthly"] = 3] = "Monthly"
})(IncentiveRecurrenceFrequency || (IncentiveRecurrenceFrequency = {}));
/** @typedef {'LicenseAvailability'|'SmsActivation'|'eAccountingActivation'|'CodeLockActivation'|'SocialActivation'|'OnlinePaymentActivation'|'FollowUpMessageActivation'|'RatingActivation'} */
export var CriteriaType;
(function (CriteriaType) {
    CriteriaType["LicenseAvailability"] = "LicenseAvailability"
    CriteriaType["SmsActivation"] = "SmsActivation"
    CriteriaType["eAccountingActivation"] = "eAccountingActivation"
    CriteriaType["CodeLockActivation"] = "CodeLockActivation"
    CriteriaType["SocialActivation"] = "SocialActivation"
    CriteriaType["OnlinePaymentActivation"] = "OnlinePaymentActivation"
    CriteriaType["FollowUpMessageActivation"] = "FollowUpMessageActivation"
    CriteriaType["RatingActivation"] = "RatingActivation"
})(CriteriaType || (CriteriaType = {}));
export class IncentiveCriteria extends BaseModel {
    /** @param {{Id?:number,IncentiveId?:number,CriteriaType?:CriteriaType,Value?:string,InvertCondition?:boolean,CreatedDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    IncentiveId;
    /** @type {CriteriaType} */
    CriteriaType;
    /** @type {string} */
    Value;
    /** @type {boolean} */
    InvertCondition;
    /** @type {string} */
    CreatedDate;
}
export class AdminIncentiveQueryResponse extends CompanyIncentiveResponse {
    /** @param {{Frequency?:IncentiveRecurrenceFrequency,RecurrenceInterval?:number,CreatedDate?:string,ModifiedDate?:string,CompanyIds?:string[],Criteria?:IncentiveCriteria[],ApplyToAllCompanies?:boolean,Id?:number,Heading?:string,StorageUrl?:string,SuccessButtonText?:string,ActionId?:number,InitialDelayInSeconds?:number,MaxDisplayCount?:number,ValidFrom?:string,ValidTo?:string,Action?:IncentiveActionResponse,Payload?:string,InitialDeferredDays?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {IncentiveRecurrenceFrequency} */
    Frequency;
    /** @type {number} */
    RecurrenceInterval;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    ModifiedDate;
    /** @type {string[]} */
    CompanyIds;
    /** @type {IncentiveCriteria[]} */
    Criteria;
    /** @type {boolean} */
    ApplyToAllCompanies;
}
export class IncentiveCriteriaDto {
    /** @param {{CriteriaType?:CriteriaType,Value?:string,InvertCondition?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CriteriaType} */
    CriteriaType;
    /** @type {string} */
    Value;
    /** @type {boolean} */
    InvertCondition;
}
export class UpdateIncentive {
    /** @param {{Id?:number,Heading?:string,StorageUrl?:string,SuccessButtonText?:string,ActionId?:number,Frequency?:IncentiveRecurrenceFrequency,RecurrenceInterval?:number,InitialDelayInSeconds?:number,MaxDisplayCount?:number,ValidFrom?:string,ValidTo?:string,CompanyIds?:string[],Criteria?:IncentiveCriteriaDto[],Payload?:string,InitialDeferredDays?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The id of the incentive. */
    Id;
    /** @type {string} */
    Heading;
    /** @type {string} */
    StorageUrl;
    /** @type {string} */
    SuccessButtonText;
    /** @type {?number} */
    ActionId;
    /** @type {IncentiveRecurrenceFrequency} */
    Frequency;
    /** @type {number} */
    RecurrenceInterval;
    /** @type {number} */
    InitialDelayInSeconds;
    /** @type {?number} */
    MaxDisplayCount;
    /** @type {string} */
    ValidFrom;
    /** @type {string} */
    ValidTo;
    /** @type {string[]} */
    CompanyIds;
    /** @type {IncentiveCriteriaDto[]} */
    Criteria;
    /** @type {string} */
    Payload;
    /**
     * @type {number}
     * @description Number of days to wait after first display attempt before displaying the incentive. Set to 0 to show immediately. */
    InitialDeferredDays;
}

JavaScript UpdateIncentive DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /superadmin/incentive/{id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Id":0,"Heading":"String","StorageUrl":"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","CompanyIds":["00000000-0000-0000-0000-000000000000"],"Criteria":[{"CriteriaType":"LicenseAvailability","Value":"String","InvertCondition":false}],"Payload":"String","InitialDeferredDays":0}

HTTP/1.1 200 OK
Content-Type: application/json
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,"Description":"String","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":[{"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"},"MonthlyPayment":true,"LicenseTypeId":0,"CountryId":"String","Price":0,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}]}},"Payload":"String","InitialDeferredDays":0}