| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read |
| POST | /company/{companyId}/incentives/{incentiveId} | Logs a user interaction with an incentive. |
|---|
export enum EngagementType
{
Read = 1,
Success = 2,
Cancelled = 3,
CheckLater = 4,
}
// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service.", StatusCode=401)
export class LogIncentiveEngage
{
/** @description The id of the company. If not provided, the company associated with the authenticated user will be used. */
// @ApiMember(Description="The id of the company. If not provided, the company associated with the authenticated user will be used.", IsRequired=true, ParameterType="path")
public CompanyId: string;
/** @description The id of the incentive. */
// @ApiMember(Description="The id of the incentive.", IsRequired=true, ParameterType="path")
public IncentiveId: number;
/** @description Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive. */
// @ApiMember(Description="Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive.", IsRequired=true)
public EngagementType: EngagementType;
public constructor(init?: Partial<LogIncentiveEngage>) { (Object as any).assign(this, init); }
}
TypeScript LogIncentiveEngage DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IncentiveId: 0,
EngagementType: Read
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}