| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read |
| POST | /company/{companyId}/incentives/{incentiveId} | Logs a user interaction with an incentive. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class EngagementType(IntEnum):
READ = 1
SUCCESS = 2
CANCELLED = 3
CHECK_LATER = 4
# @ValidateRequest(Validator="IsAuthenticated")
# @ApiResponse(Description="You were unauthorized to call this service.", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LogIncentiveEngage:
# @ApiMember(Description="The id of the company. If not provided, the company associated with the authenticated user will be used.", IsRequired=true, ParameterType="path")
company_id: Optional[str] = None
"""
The id of the company. If not provided, the company associated with the authenticated user will be used.
"""
# @ApiMember(Description="The id of the incentive.", IsRequired=true, ParameterType="path")
incentive_id: int = 0
"""
The id of the incentive.
"""
# @ApiMember(Description="Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive.", IsRequired=true)
engagement_type: Optional[EngagementType] = None
"""
Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive.
"""
Python 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
{
}