BokaMera.API.Host

LogIncentiveEngage

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

The following routes are available for this service:
POST	/company/{companyId}/incentives/{incentiveId}	Logs a user interaction with an incentive.

"use strict";
/** @typedef {number} */
export var EngagementType;
(function (EngagementType) {
    EngagementType[EngagementType["Read"] = 1] = "Read"
    EngagementType[EngagementType["Success"] = 2] = "Success"
    EngagementType[EngagementType["Cancelled"] = 3] = "Cancelled"
    EngagementType[EngagementType["CheckLater"] = 4] = "CheckLater"
})(EngagementType || (EngagementType = {}));
export class LogIncentiveEngage {
    /** @param {{CompanyId?:string,IncentiveId?:number,EngagementType?:EngagementType}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The id of the company. If not provided, the company associated with the authenticated user will be used. */
    CompanyId;
    /**
     * @type {number}
     * @description The id of the incentive. */
    IncentiveId;
    /**
     * @type {EngagementType}
     * @description Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive. */
    EngagementType;
}

JavaScript LogIncentiveEngage 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 /company/{companyId}/incentives/{incentiveId} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LogIncentiveEngage 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>
  <EngagementType>Read</EngagementType>
  <IncentiveId>0</IncentiveId>
</LogIncentiveEngage>

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

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />