BokaMera.API.Host

<back to all web services

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.
LogIncentiveEngage Parameters:
NameParameterData TypeRequiredDescription
CompanyIdpathGuidYesThe id of the company. If not provided, the company associated with the authenticated user will be used.
IncentiveIdpathintYesThe id of the incentive.
EngagementTypebodyEngagementTypeYesSpecifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive.
EngagementType Enum:
NameValue
Read1
Success2
Cancelled3
CheckLater4

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.

POST /company/{companyId}/incentives/{incentiveId} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"IncentiveId":0,"EngagementType":"Read"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}