BokaMera.API.Host

CompanyIncentiveQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin

The following routes are available for this service:
GET	/companies/{CompanyId}/incentives	It gets either incentives which are not read or engaged by the current company/administrator.

"use strict";
export class BaseModel {
    constructor(init) { Object.assign(this, init) }
}
/** @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 IncentiveAction extends BaseModel {
    /** @param {{Id?:number,ActionType?:IncentiveActionType,Page?:string,Segment?:string,Element?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {IncentiveActionType} */
    ActionType;
    /** @type {string} */
    Page;
    /** @type {string} */
    Segment;
    /** @type {string} */
    Element;
}
export class CompanyIncentiveResponse {
    /** @param {{Id?:number,Heading?:string,StorageUrl?:string,SuccessButtonText?:string,ActionId?:number,InitialDelayInSeconds?:number,MaxDisplayCount?:number,ValidFrom?:string,ValidTo?:string,Action?:IncentiveAction,Payload?:string}} [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 {IncentiveAction} */
    Action;
    /** @type {string} */
    Payload;
}
export class CompanyIncentivesQueryResponse {
    /** @param {{Incentives?:IList<CompanyIncentiveResponse>,CompanyId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IList<CompanyIncentiveResponse>} */
    Incentives;
    /** @type {string} */
    CompanyId;
}
export class CompanyIncentiveQuery {
    /** @param {{CompanyId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
}

JavaScript CompanyIncentiveQuery 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.

GET /companies/{CompanyId}/incentives HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

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

<CompanyIncentivesQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Incentives i:nil="true" />
</CompanyIncentivesQueryResponse>